Search Results for

    Show / Hide Table of Contents

    Class TextProperty

    Represents a property of type text in the Time Cockpit data model.

    Inheritance
    System.Object
    DynamicObject
    NamedDynamicObject
    ModelElement
    ModelProperty
    PersistedProperty
    TextProperty
    Implements
    System.Dynamic.IDynamicMetaObjectProvider
    System.ComponentModel.INotifyPropertyChanged
    System.ComponentModel.IDataErrorInfo
    INullable
    Inherited Members
    PersistedProperty.ValidationScript
    PersistedProperty.StorageColumn
    ModelProperty.IsValueAffectedByPropertyChange(EntityObject, String)
    ModelProperty.Accept(ModelElementVisitor)
    ModelProperty.ShallowCopy(String, PersistBehavior, Ownership, Boolean, Boolean)
    ModelProperty.ShallowCopy()
    ModelProperty.OnDeserializing(StreamingContext)
    ModelProperty.Attach(ModelElement)
    ModelProperty.GetHumanReadableMemberPath()
    ModelProperty.InvariantFriendlyTypeName
    ModelProperty.IsNullable
    ModelProperty.IsDefaultDisplayProperty
    ModelProperty.DefaultValueExpression
    ModelProperty.EvaluateDefaultValueExpression
    ModelProperty.HasDefaultValueExpression
    ModelProperty.DefaultValueFunction
    ModelProperty.EvaluateDefaultValueFunction
    ModelProperty.EvaluateDefaultValue
    ModelProperty.DefaultValue
    ModelProperty.Permissions
    ModelProperty.DefaultAggregateFunction
    ModelElement.IsValidIdentifier(String)
    ModelElement.Detach()
    ModelElement.SetOwnershipPrefix(String)
    ModelElement.UpdateChildren(NotifyCollectionChangedEventArgs)
    ModelElement.SetPersistBehavior(PersistBehavior)
    ModelElement.SetName(String)
    ModelElement.SetOwnership(Ownership)
    ModelElement.ElementGuid
    ModelElement.Name
    ModelElement.Parent
    ModelElement.Children
    ModelElement.PersistBehavior
    ModelElement.IsFullPersistBehavior
    ModelElement.IsNonePersistBehavior
    ModelElement.IsSystemElement
    ModelElement.IsApplicationSpecificElement
    ModelElement.IsUserElement
    ModelElement.IsSystemOrApplicationSpecificElement
    ModelElement.InvariantFriendlyName
    ModelElement.CreationVersion
    ModelElement.LastUpdateVersion
    ModelElement.Error
    ModelElement.ErrorSummary
    ModelElement.IsValid
    ModelElement.Ownership
    ModelElement.OwnershipPrefix
    ModelElement.NonPrefixedName
    NamedDynamicObject.OnPropertyChanged(String)
    NamedDynamicObject.PropertyChanged
    DynamicObject.GetMember(String)
    DynamicObject.SetMember(String, Object)
    DynamicObject.GetMetaObject(Expression)
    System.Object.ToString()
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    Namespace: TimeCockpit.Data.DataModel
    Assembly: TimeCockpit.Data.dll
    Syntax
    [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)
    In This Article
    Back to top Copyright © 2020 software architects gmbh