Options
All
  • Public
  • Public/Protected
  • All
Menu

Class FormattingInfo

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Accessors

container

containerAsClientTemplateParameter

containerAsDataGridColumn

containerAsDatePicker

containerAsDynamicLabel

containerAsGridColumn

containerAsReferenceSelector

containerAsTextBox

customDateFormat

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

dateFormat

decimalPrecision

  • get (): number
  • set (newValue: number): any

  • Returns number

  • Parameters

    • newValue: number

    Returns any

enumFormat

groupDigits

  • get (): boolean
  • set (newValue: boolean): any

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns any

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

model

unit

Methods

allProperties

  • allProperties(): AbstractProperty<any, any>[]

asLoaded

  • asLoaded(): this

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

    Returns this

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

  • detach(): this

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns this

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: function, forceRefresh?: undefined | false | true): void
  • load(forceRefresh?: undefined | false | true): Promise<this>

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

    Parameters

    • callback: function
        • (elem: this): void

        • Parameters

          • elem: this

          Returns void

    • Optional forceRefresh: undefined | false | true

    Returns void

  • Parameters

    • Optional forceRefresh: undefined | false | true

    Returns Promise<this>

loadedProperties

  • loadedProperties(): AbstractProperty<any, any>[]

publicProperties

  • publicProperties(): AbstractProperty<any, any>[]

toJSON

traverse

  • traverse(visit: function): void

traverseFind

  • traverseFind<T>(visit: function): T | null

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 createInClientTemplateParameterUnderFormattingInfo

  • 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 ClientTemplateParameter element passed as argument.

    Warning! Can only be used on models with the following Mendix meta model versions: 7.15.0 and higher

    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