[DataType(typeof(string))]
[Column(typeof(string), SizePropertyName = "MaxStorageSize")]
[DefaultValue("")]
[FriendlyTypeName("Text")]
public class TextProperty : PersistedProperty, IDynamicMetaObjectProvider, INotifyPropertyChanged, IDataErrorInfo, INullable

Constructors

TextProperty()

Initializes a new instance of the TextProperty class.

Declaration

public TextProperty()

TextProperty(IEnumerable<KeyValuePair<Object, Object>>)

Initializes a new instance of the TextProperty class.

Declaration

public TextProperty(IEnumerable<KeyValuePair<object, object>> properties)

Parameters

Type	Name	Description
System.Collections.Generic.IEnumerable<System.Collections.Generic.KeyValuePair<System.Object, System.Object>>	properties	Collection of properties.

TextProperty(TextProperty)

Initializes a new instance of the TextProperty class.

Declaration

public TextProperty(TextProperty element)

Parameters

Type	Name	Description
TextProperty	element	The element.

Properties

ClrDefaultValue

Gets the default valud for the datatype for the property.

Declaration

public override object ClrDefaultValue { get; }

Property Value

Type	Description
System.Object

Overrides

ModelProperty.ClrDefaultValue

DataType

Gets the datatype for the property.

Declaration

public override Type DataType { get; }

Property Value

Type	Description
System.Type

Overrides

ModelProperty.DataType

IsLocalized

Gets or sets a value indicating whether this instance is localized.

Declaration

public bool IsLocalized { get; set; }

Property Value

Type	Description
System.Boolean	`true` if this instance is localized; otherwise, `false`.

MaxStorageSize

Gets or sets the maximum storage size of the text property.

Declaration

[SchemaDatabaseMapping(SchemaDatabaseColumn.PropertyLengthPrecision)]
public int MaxStorageSize { get; set; }

Property Value

Type	Description
System.Int32

Remarks

This property determines the maximum number of characters that can be stored in the text property. The value has to be between 1 and 4000 or System.Int32.MaxValue if the storage size should not be restricted (i.e. uses a data type like VARCHAR(MAX) in the database.

The default value is System.Int32.MaxValue.

Exceptions

Type	Condition
System.ArgumentException	Value is <=0 or >4000 and not System.Int32.MaxValue.

Methods

Convert(Object)

Converts an object to the type of the property.

Declaration

public override object Convert(object value)

Parameters

Type	Name	Description
System.Object	value	Object to convert.

Returns

Type	Description
System.Object	Returns the converted object.

Overrides

ModelProperty.Convert(Object)

Validate(ref IList<PropertyValidationMessage>, Boolean)

Validates a ModelElement according to certain rules.

Declaration

protected override void Validate(ref IList<PropertyValidationMessage> messages, bool validateRecursively)

Parameters

Type	Name	Description
System.Collections.Generic.IList<PropertyValidationMessage>	messages	An list of strings that stores that picks up the validation errors of a model element.
System.Boolean	validateRecursively	Indicates whether to validate only the current model element or all its children (recursively) as well.

Overrides

ModelProperty.Validate(ref IList<PropertyValidationMessage>, Boolean)

Remarks

The rules the ModelElement is validated against are dependent on the type of ModelElement that is validated. This method can be overridden to provide custom validation behavior for subclasses of ModelElement

When Validate(ref IList<PropertyValidationMessage>, Boolean) is called on a model element, the Validate(ref IList<PropertyValidationMessage>, Boolean) method of all children attached to the model element are validated recursively.

ValidateValue(Object, out String)

Validates that the value is either a string value or null. Additionally verifies that the length of the string is less that MaxStorageSize.

Declaration

public override bool ValidateValue(object value, out string errorMessage)

Parameters

Type	Name	Description
System.Object	value	The value to verify.
System.String	errorMessage	The resulting error message, or null if the value is valid.

Returns

Type	Description
System.Boolean	Returns true if the `value` is valid for the property, false otherwise.

Overrides

ModelProperty.ValidateValue(Object, out String)