Class DataType<T>

Namespace

CMS.DataEngine

Assembly

CMS.DataEngine.dll

Data type definition

public class DataType<T> : DataType

Type Parameters

T

Inheritance

object

DataType

DataType<T>

Inherited Members

DataType.mTextSerializer

DataType.TypeGroup

DataType.TypeAlias

DataType.Type

DataType.FieldType

DataType.SqlType

DataType.SchemaType

DataType.SqlValueFormat

DataType.IsDefaultType

DataType.DbType

DataType.TypeName

DataType.Hidden

DataType.CodeValueFormat

DataType.SpecialDefaultValues

DataType.AllowEmpty

DataType.StringFormat

DataType.GetFormatProvider

DataType.HasConfigurableDefaultValue

DataType.TextSerializer

DataType.IsAvailableForDataClass

DataType.VariableSize

DataType.DefaultSize

DataType.MaxSize

DataType.MaxValueLength

DataType.VariablePrecision

DataType.DefaultPrecision

DataType.MaxPrecision

DataType.GetSqlType(int, int)

DataType.GetSqlValue(object)

DataType.GetDefaultValueCode(string, bool)

DataType.GetString(object, CultureInfo)

DataType.FormatValue(object, CultureInfo)

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

DataType(string, string, string, Func<object, T, CultureInfo, T>)

Constructor

public DataType(string sqlType, string fieldType, string schemaType, Func<object, T, CultureInfo, T> conversionFunc)

Parameters

sqlType string

SQL type

fieldType string

Field type

schemaType string

Schema type

conversionFunc Func<object, T, CultureInfo, T>

Conversion function

DataType(string, string, string, Func<object, T, CultureInfo, T>, Func<object, CultureInfo, bool>)

Constructor

public DataType(string sqlType, string fieldType, string schemaType, Func<object, T, CultureInfo, T> conversionFunc, Func<object, CultureInfo, bool> validationFunction)

Parameters

sqlType string

SQL type

fieldType string

Field type

schemaType string

Schema type

conversionFunc Func<object, T, CultureInfo, T>

Conversion function

validationFunction Func<object, CultureInfo, bool>

Determines whether passed object value is of this data type.

DataType(string, string, string, Func<object, T, CultureInfo, T>, Func<T, object, CultureInfo, object>, IDataTypeTextSerializer)

Constructor

public DataType(string sqlType, string fieldType, string schemaType, Func<object, T, CultureInfo, T> conversionFunc, Func<T, object, CultureInfo, object> dbConversionFunc, IDataTypeTextSerializer textSerializer)

Parameters

sqlType string

SQL type

fieldType string

Field type

schemaType string

Schema type

conversionFunc Func<object, T, CultureInfo, T>

Conversion function

dbConversionFunc Func<T, object, CultureInfo, object>

Function which converts value to its database representation.

textSerializer IDataTypeTextSerializer

Text serializer used for this type.

DataType(string, string, string, Func<object, T, CultureInfo, T>, Func<T, object, CultureInfo, object>, IDataTypeTextSerializer, Func<object, CultureInfo, bool>)

Constructor

public DataType(string sqlType, string fieldType, string schemaType, Func<object, T, CultureInfo, T> conversionFunc, Func<T, object, CultureInfo, object> dbConversionFunc, IDataTypeTextSerializer textSerializer, Func<object, CultureInfo, bool> validationFunction)

Parameters

sqlType string

SQL type

fieldType string

Field type

schemaType string

Schema type

conversionFunc Func<object, T, CultureInfo, T>

Conversion function

dbConversionFunc Func<T, object, CultureInfo, object>

Function which converts value to its database representation.

textSerializer IDataTypeTextSerializer

Text serializer used for this type.

validationFunction Func<object, CultureInfo, bool>

Determines whether passed object value is of this data type.

Fields

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 Func<object, CultureInfo, bool> IsOfTypeFunction

Field Value

Func<object, CultureInfo, bool>

Properties

ConversionFunc

Conversion function for this data type

protected Func<object, T, CultureInfo, T> ConversionFunc { get; set; }

Property Value

Func<object, T, CultureInfo, T>

ConversionMethod

Returns the conversion method

public override string ConversionMethod { get; set; }

Property Value

string

DbConversionFunc

Conversion function which converts value to its database representation. If not defined, value is used without any conversions.

protected Func<T, object, CultureInfo, object> DbConversionFunc { get; set; }

Property Value

Func<T, object, CultureInfo, object>

DefaultValue

Default value for this data type

public T DefaultValue { get; set; }

Property Value

T

DefaultValueCode

Code of the default value for this type

public override string DefaultValueCode { get; set; }

Property Value

string

ObjectDefaultValue

Default value for this data type

public override object ObjectDefaultValue { get; }

Property Value

object

Methods

Convert(object, CultureInfo, object)

Converts the value to a proper type

public override object Convert(object value, CultureInfo culture, object defaultValue)

Parameters

value object

Value to convert

culture CultureInfo

Culture used for conversion of the type

defaultValue object

Default value to return in case the conversion fails

Returns

object

ConvertToDbType(object, CultureInfo, object)

Converts the value to its database representation.

public override object ConvertToDbType(object value, CultureInfo culture, object defaultValue)

Parameters

value object

Value to convert

culture CultureInfo

Culture used for conversion of the type

defaultValue object

Default value to return in case the conversion fails

Returns

object

IsValueOfType(object, CultureInfo)

Uses IsOfTypeFunction to determine whether given value is of this data type.

public override bool IsValueOfType(object value, CultureInfo culture)

Parameters

value object

Object to be tested.

culture CultureInfo

Culture to tests object for.

Returns

bool

True if object is of this data type or if IsOfTypeFunction is null. Otherwise returns false.