Class DataProperty

Definition of a data property.

Since

2.0

Hierarchy (view full)

Implements

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

Cast

  • Cast<T1, T2>(this, type): T1

  • 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

Equals

  • Equals(obj): boolean

  • 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.

GetHashCode

  • GetHashCode(): number

  • Serves as the default hash function.

    Returns number

    A hash code for the current object.

ToString

  • ToString(): string

  • Returns a string that represents the current object.

    Returns string

    A string that represents the current object.

TryCast

  • TryCast<T1, T2>(this, type): null | T1

  • 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

StaticEquals

  • Equals(objA, objB): boolean

  • 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

Attributes

Context

  • get Context(): INodeContext

  • Gets the context of this node.

    Returns INodeContext

    Since

    2.0

Description

  • get Description(): string

  • Gets a description of the property.

    Returns string

    Since

    2.0

HasDefaultValue

  • get HasDefaultValue(): boolean

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

    Returns boolean

    Since

    2.0

HasInheritedType

  • 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

    Since

    2.0

IsAttached

  • get IsAttached(): boolean

  • Gets a value indicating whether this node is attached.

    Returns boolean

    Since

    2.0

IsCalculated

  • get IsCalculated(): boolean

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

    Returns boolean

    Since

    2.0

IsListValued

  • get IsListValued(): boolean

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

    Returns boolean

    Since

    2.0

IsPropagated

  • 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

    Since

    2.0

IsStandard

  • get IsStandard(): boolean

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

    Returns boolean

    Since

    2.0

IsUserEditable

  • get IsUserEditable(): boolean

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

    Returns boolean

    Since

    2.0

IsUserVisible

  • get IsUserVisible(): boolean

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

    Returns boolean

    Since

    2.0

Name

  • get Name(): string

  • Gets or sets the name of the data property.

    Returns string

    Since

    2.0

  • set Name(value): void

  • Parameters

    • value: string

    Returns void

Transactions

  • get Transactions(): ITransactions

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

    Returns ITransactions

    Since

    2.0

Value

  • get Value(): unknown

  • Gets or sets the default value of the data property.

    Returns unknown

    Since

    2.0

  • set Value(value): void

  • Parameters

    • value: unknown

    Returns void

StaticDefaultAttributes

StaticCreateCustomPrototype

  • CreateCustomPrototype(propertyName, dataType, attributes): DataProperty

  • Creates a prototype for a custom data property.

    Parameters

    Returns DataProperty

    A data property prototype.

    Since

    2.0

  • CreateCustomPrototype(propertyName, defaultValue, dataType, attributes): DataProperty

  • Creates a prototype for a custom data property.

    Parameters

    • propertyName: string | String

      The property name, must be a qualified name.

    • defaultValue: any

      The default value.

    • dataType: DataType

      The data type.

    • attributes: DataPropertyAttributes

      The property attributes.

    Returns DataProperty

    A data property prototype.

    Since

    2.0

  • CreateCustomPrototype(propertyName, description, defaultValue, dataType, attributes): DataProperty

  • Creates a prototype for a custom data property.

    Parameters

    • propertyName: string | String

      The property name, must be a qualified name.

    • description: string | String

      The description of the property.

    • defaultValue: any

      The default value.

    • dataType: DataType

      The value type.

    • attributes: DataPropertyAttributes

      The property attributes.

    Returns DataProperty

    A data property prototype.

    Since

    2.0

Settings

Member Visibility

On This Page

Methods
Default capability