Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormattingInfo

Hierarchy

Implements

Index

Constructors

constructor

Properties

Private ___customDateFormat

___customDateFormat: any

Private ___dateFormat

___dateFormat: any

Private ___decimalPrecision

___decimalPrecision: any

Private ___enumFormat

___enumFormat: any

Private ___groupDigits

___groupDigits: any

container

container: AbstractElement

containerAsDataGridColumn

containerAsDataGridColumn: DataGridColumn

containerAsDatePicker

containerAsDatePicker: DatePicker

containerAsDynamicLabel

containerAsDynamicLabel: DynamicLabel

containerAsGridColumn

containerAsGridColumn: GridColumn

containerAsReferenceSelector

containerAsReferenceSelector: ReferenceSelector

containerAsTextBox

containerAsTextBox: TextBox

customDateFormat

customDateFormat: string

dateFormat

dateFormat: DateFormat

decimalPrecision

decimalPrecision: number

enumFormat

enumFormat: EnumFormat

groupDigits

groupDigits: boolean

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

  • if false, a load is required to access these properties.

model

model: IModel

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

Static typeName

typeName: string

Static versionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void
  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T
  • Transforms a IElement interface into a Element class, loading the containing unit if necessary. (Those are technically already the same, but this function makes sure its properties are available.)

    • If invoked without callback, it checks whether the properties are available or it will throw;
    • If invoked with callback, it will load the data from the server if needed, and then invoke the callback.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void
        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

traversePublicParts

  • traversePublicParts(visit: function): void

Static create

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. Expects one argument: the IModel object the instance will "live on". After creation, assign or add this instance to a property that accepts this kind of objects.

    Parameters

    Returns FormattingInfo

Static createInDataGridColumnUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent documenttemplates.DataGridColumn element passed as argument.

    Parameters

    Returns FormattingInfo

Static createInDatePickerUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent DatePicker element passed as argument.

    Parameters

    Returns FormattingInfo

Static createInDynamicLabelUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent documenttemplates.DynamicLabel element passed as argument.

    Parameters

    Returns FormattingInfo

Static createInGridColumnUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent GridColumn element passed as argument.

    Parameters

    Returns FormattingInfo

Static createInReferenceSelectorUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent ReferenceSelector element passed as argument.

    Parameters

    Returns FormattingInfo

Static createInTextBoxUnderFormattingInfo

  • Creates and returns a new FormattingInfo instance in the SDK and on the server. The new FormattingInfo will be automatically stored in the 'formattingInfo' property of the parent TextBox element passed as argument.

    Parameters

    Returns FormattingInfo

Generated using TypeDoc