DataType 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 abstract class DataType

The DataType type exposes the following members.

Constructors

	Name	Description
Protected method	DataType

Fields

	Name	Description
Protected field	mTextSerializer	Serializer used to serialize and deserialize values of this data type.

Properties

	Name	Description
Public property	AllowAsAliasSource	Returns true if the field can be used as an alias source
Public property	AllowedObjectTypes	When configured, only allows data type for the given object types. Use case insensitive HashSet for the list of items
Public property	AllowEmpty	If true, the data type allows for nulls in the database
Public property	CodeValueFormat	Formatting code of the value for this type
Public property	ConversionMethod	Returns the conversion method
Public property	DbType	Database type
Public property	DefaultPrecision	Default precision of the type, if the precision is variable
Public property	DefaultSize	Default size of the type, if the size is variable
Public property	DefaultValueCode	Code of the default value for this type
Public property	FieldType	Field type
Public property	GetFormatProvider	Function which gets a format provider for the given culture
Public property	HasConfigurableDefaultValue	Returns true if the type has a default value
Public property	Hidden	If true, the data type is hidden
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.
Public property	MaxPrecision	Maximum precision of the type, if the precision is variable
Public property	MaxSize	Maximum size of the type, if the size is variable
Public property	MaxValueLength	Maximum value length
Public property	ObjectDefaultValue	Default value for this data type
Public property	SchemaType	Type representation in the XML schema of the data
Public property	SpecialDefaultValues	List of special default values recognized by this type and treated as default value by the code
Public property	SqlType	SQL data type representation
Public property	SqlValueFormat	SQL value format. Default format is '{0}' to prevent SQL injection
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.
Public property	SupportsTranslation	If true, the data type supports translation of the content
Public property	TextSerializer	Gets the IDataTypeTextSerializer instance for this data type.
Public property	Type	System type
Public property	TypeAlias	System type alias (e.g. bool for Boolean, etc.)
Public property	TypeGroup	Name of the group that groups together types with similar behavior, such as integer, decimal, string etc.
Public property	TypeName	Represents database type name
Public property	VariablePrecision	If true, the data type has variable precision
Public property	VariableSize	If true, the data type has variable size

Methods

	Name	Description
Public method	Convert	Converts the value to a proper type
Public method	ConvertToDbType	Converts the value to its database representation.
Protected method	FormatValue	Formats the given value
Public method	GetDefaultValueCode	Gets the code for the default value of this type in C# code
Public method	GetSqlType	Gets the SQL data type representation
Public method	GetSqlValue	Gets the SQL value representation for this type
Public method	GetString	Gets the string representation of the given value
Public method	IsAvailableForObjectType	Returns true if the given data type is available for the given object type
Public method	IsValueOfType	Determines whether given value is of this data type.