Action
    Preparing search index...

    Class DataProperty

    Definition of a data property.

    2.0

    Hierarchy (View Summary)

    Implements

    Index

    Methods

    Cast Equals GetHashCode ToString TryCast Equals

    Default capability

    Attributes Context Description HasDefaultValue HasInheritedType IsAttached IsCalculated IsListValued IsPropagated IsStandard IsUserEditable IsUserVisible Name Transactions Value DefaultAttributes CreateCustomPrototype

    Methods

    • Casts this object to the specified type. Throws error on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns T1

    • Determines whether the specified object is equal to the current object.

      Parameters

      • obj: any

        The object to compare with the current object.

      Returns boolean

      true if the specified object is equal to the current object; otherwise, false.

    • Serves as the default hash function.

      Returns number

      A hash code for the current object.

    • Returns a string that represents the current object.

      Returns string

      A string that represents the current object.

    • Casts this object to the specified type. Returns null on failure.

      Type Parameters

      • T1

        The target type of the cast.

      • T2

        The type of the object to cast.

      Parameters

      Returns null | T1

    • Determines whether the specified object instances are considered equal.

      Parameters

      • objA: any

        The first object to compare.

      • objB: any

        The second object to compare.

      Returns boolean

      true if the objects are considered equal; otherwise, false. If both objA and objB are null, the method returns true.

    Default capability

    • get Context(): INodeContext

      Gets the context of this node.

      Returns INodeContext

      2.0

    • get Description(): string

      Gets a description of the property.

      Returns string

      2.0

    • get HasDefaultValue(): boolean

      Gets a value indicating whether this property has a default value.

      Returns boolean

      2.0

    • get HasInheritedType(): boolean

      Gets a value indicating whether the property has a value type that is derived from the container. For example, a column property that is a list of column values.

      Returns boolean

      2.0

    • get IsAttached(): boolean

      Gets a value indicating whether this node is attached.

      Returns boolean

      2.0

    • get IsCalculated(): boolean

      Gets a value indicating whether the property value is calculated or derived from the context.

      Returns boolean

      2.0

    • get IsListValued(): boolean

      Gets a value indicating whether the property takes multiple values (the value is an array).

      Returns boolean

      2.0

    • get IsPropagated(): boolean

      Gets a value indicating whether the property shall be copied to objects derived from the container. For example, a column property that is propagated to a derived data view.

      Returns boolean

      2.0

    • get IsStandard(): boolean

      Gets a value indicating whether this is a standard data property.

      Returns boolean

      2.0

    • get IsUserEditable(): boolean

      Gets a value indicating whether the property value can be edited by the user.

      Returns boolean

      2.0

    • get IsUserVisible(): boolean

      Gets a value indicating whether the property can be displayed in the Data Properties UI.

      Returns boolean

      2.0

    • get Name(): string

      Gets or sets the name of the data property.

      Returns string

      Do not use the setter of this property. It is in practice obsolete but can not be made so due to a bug in the compiler that does not allow setting the obsolete attribute on only the setter. Changing the name will effectively render it another property in many places that only recognize properties by name.

      2.0

    • set Name(value: string): void

      Parameters

      • value: string

      Returns void

    • get Transactions(): ITransactions

      Gets a collection of methods for executing transactions on the document.

      Returns ITransactions

      2.0

    • get Value(): unknown

      Gets or sets the default value of the data property.

      Returns unknown

      2.0

    • set Value(value: unknown): void

      Parameters

      • value: unknown

      Returns void

    Settings

    Member Visibility

    On This Page

    Methods
    Default capability