DataType<T> Class

Data type definition

Inheritance Hierarchy

System.Object
  CMS.DataEngine.DataType
    CMS.DataEngine.DataType<T>

Namespace: CMS.DataEngine
Assembly: CMS.DataEngine (in CMS.DataEngine.dll) Version: 13.0.131

Syntax

public class DataType<T> : DataType

Type Parameters

T

The DataType<T> type exposes the following members.

Constructors

	Name	Description
Public method	DataType<T>(String, String, String, Func<Object, T, CultureInfo, T>)	Constructor
Public method	DataType<T>(String, String, String, Func<Object, T, CultureInfo, T>, Func<Object, CultureInfo, Boolean>)	Constructor
Public method	DataType<T>(String, String, String, Func<Object, T, CultureInfo, T>, Func<T, Object, CultureInfo, Object>, IDataTypeTextSerializer)	Constructor
Public method	DataType<T>(String, String, String, Func<Object, T, CultureInfo, T>, Func<T, Object, CultureInfo, Object>, IDataTypeTextSerializer, Func<Object, CultureInfo, Boolean>)	Constructor

Fields

	Name	Description
Protected field	IsOfTypeFunction	Function used to determine whether a given value is of this data type. If left null, all objects are considered to be of this type.
Protected field	mTextSerializer	Serializer used to serialize and deserialize values of this data type. (Inherited from DataType.)

Properties

	Name	Description
Public property	AllowAsAliasSource	Returns true if the field can be used as an alias source (Inherited from DataType.)
Public property	AllowedObjectTypes	When configured, only allows data type for the given object types. Use case insensitive HashSet for the list of items (Inherited from DataType.)
Public property	AllowEmpty	If true, the data type allows for nulls in the database (Inherited from DataType.)
Public property	CodeValueFormat	Formatting code of the value for this type (Inherited from DataType.)
Protected property	ConversionFunc	Conversion function for this data type
Public property	ConversionMethod	Returns the conversion method (Overrides DataType.ConversionMethod.)
Protected property	DbConversionFunc	Conversion function which converts value to its database representation. If not defined, value is used without any conversions.
Public property	DbType	Database type (Inherited from DataType.)
Public property	DefaultPrecision	Default precision of the type, if the precision is variable (Inherited from DataType.)
Public property	DefaultSize	Default size of the type, if the size is variable (Inherited from DataType.)
Public property	DefaultValue	Default value for this data type
Public property	DefaultValueCode	Code of the default value for this type (Overrides DataType.DefaultValueCode.)
Public property	FieldType	Field type (Inherited from DataType.)
Public property	GetFormatProvider	Function which gets a format provider for the given culture (Inherited from DataType.)
Public property	HasConfigurableDefaultValue	Returns true if the type has a default value (Inherited from DataType.)
Public property	Hidden	If true, the data type is hidden (Inherited from DataType.)
Public property	IsDefaultType	If true, the data type is considered default. Types marked as default are replaced only by default types in the type mapping tables. (Inherited from DataType.)
Public property	MaxPrecision	Maximum precision of the type, if the precision is variable (Inherited from DataType.)
Public property	MaxSize	Maximum size of the type, if the size is variable (Inherited from DataType.)
Public property	MaxValueLength	Maximum value length (Inherited from DataType.)
Public property	ObjectDefaultValue	Default value for this data type (Overrides DataType.ObjectDefaultValue.)
Public property	SchemaType	Type representation in the XML schema of the data (Inherited from DataType.)
Public property	SpecialDefaultValues	List of special default values recognized by this type and treated as default value by the code (Inherited from DataType.)
Public property	SqlType	SQL data type representation (Inherited from DataType.)
Public property	SqlValueFormat	SQL value format. Default format is '{0}' to prevent SQL injection (Inherited from DataType.)
Public property	StringFormat	If defined, the given format is used to convert the value of this type to a string value. {0} represents the value. (Inherited from DataType.)
Public property	SupportsTranslation	If true, the data type supports translation of the content (Inherited from DataType.)
Public property	TextSerializer	Gets the IDataTypeTextSerializer instance for this data type. (Inherited from DataType.)
Public property	Type	System type (Inherited from DataType.)
Public property	TypeAlias	System type alias (e.g. bool for Boolean, etc.) (Inherited from DataType.)
Public property	TypeGroup	Name of the group that groups together types with similar behavior, such as integer, decimal, string etc. (Inherited from DataType.)
Public property	TypeName	Represents database type name (Inherited from DataType.)
Public property	VariablePrecision	If true, the data type has variable precision (Inherited from DataType.)
Public property	VariableSize	If true, the data type has variable size (Inherited from DataType.)

Methods

	Name	Description
Public method	Convert	Converts the value to a proper type (Overrides DataType.Convert(Object, CultureInfo, Object).)
Public method	ConvertToDbType	Converts the value to its database representation. (Overrides DataType.ConvertToDbType(Object, CultureInfo, Object).)
Protected method	FormatValue	Formats the given value (Inherited from DataType.)
Public method	GetDefaultValueCode	Gets the code for the default value of this type in C# code (Inherited from DataType.)
Public method	GetSqlType	Gets the SQL data type representation (Inherited from DataType.)
Public method	GetSqlValue	Gets the SQL value representation for this type (Inherited from DataType.)
Public method	GetString	Gets the string representation of the given value (Inherited from DataType.)
Public method	IsAvailableForObjectType	Returns true if the given data type is available for the given object type (Inherited from DataType.)
Public method	IsValueOfType	Uses IsOfTypeFunction to determine whether given value is of this data type. (Overrides DataType.IsValueOfType(Object, CultureInfo).)