Options
All
  • Public
  • Public/Protected
  • All
Menu

Class LayoutCall

In version 7.17.0: added public

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

arguments

containerAsLayout

containerAsPage

containerAsPageTemplate

containerAsWebLayoutContent

isLoaded

  • get (): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

layout

  • In version 8.0.0: removed optional In version 7.17.0: added public

    Returns ILayout | null

  • In version 8.0.0: removed optional In version 7.17.0: added public

    Parameters

    Returns any

layoutQualifiedName

  • get (): string | null
  • Returns string | null

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 LayoutCall 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 LayoutCall

Static createInLayoutUnderLayoutCall

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

    Warning! Can only be used on models with the following Mendix meta model versions: 6.0.0 to 7.23.0

    Parameters

    Returns LayoutCall

Static createInPageTemplateUnderLayoutCall

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

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

    Parameters

    Returns LayoutCall

Static createInPageUnderLayoutCall

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

    Parameters

    Returns LayoutCall

Static createInWebLayoutContentUnderLayoutCall

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

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

    Parameters

    Returns LayoutCall

Generated using TypeDoc