Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageVariable

In version 8.4.0: introduced

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$PageVariable"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

  • get container(): TContainer

  • Returns TContainer

containerAsAssociationWidget

containerAsAttributeWidget

containerAsClientTemplateParameter

containerAsConditionalSettings

containerAsDeleteClientAction

containerAsEntityPathSource

containerAsMicroflowParameterMapping

containerAsNanoflowParameterMapping

containerAsPageParameterMapping

containerAsSnippetParameterMapping

containerAsTabContainer

containerAsWidgetValue

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

localVariable

  • In version 10.17.0: introduced

    Returns null | LocalVariable

  • In version 10.17.0: introduced

    Parameters

    Returns void

localVariableLocalName

  • get localVariableLocalName(): null | string

  • Returns null | string

model

  • get model(): TModel

  • Returns TModel

pageParameter

  • In version 9.5.0: introduced

    Returns null | PageParameter

  • In version 9.5.0: introduced

    Parameters

    Returns void

pageParameterLocalName

  • get pageParameterLocalName(): null | string

  • Returns null | string

snippetParameter

snippetParameterLocalName

  • get snippetParameterLocalName(): null | string

  • Returns null | string

unit

useAllPages

  • get useAllPages(): boolean
  • set useAllPages(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

widget

widgetLocalName

  • get widgetLocalName(): null | string

  • Returns null | string

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

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

    Returns PageVariable

findElementById

Protected getContainerAs

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

load

  • load(callback: (elem: PageVariable) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<PageVariable>

  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<PageVariable>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static create

  • Creates and returns a new PageVariable 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

    • model: IModel

    Returns PageVariable

Static createInAssociationWidgetUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInAttributeWidgetUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInClientTemplateParameterUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInConditionalSettingsUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInDeleteClientActionUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInEntityPathSourceUnderSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInMicroflowParameterMappingUnderVariable

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

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

    Parameters

    Returns PageVariable

Static createInNanoflowParameterMappingUnderVariable

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

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

    Parameters

    Returns PageVariable

Static createInPageParameterMappingUnderVariable

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

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

    Parameters

    Returns PageVariable

Static createInSnippetParameterMappingUnderVariable

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

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

    Parameters

    Returns PageVariable

Static createInTabContainerUnderActivePageSourceVariable

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

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

    Parameters

    Returns PageVariable

Static createInWidgetValueUnderSourceVariable

  • Creates and returns a new PageVariable instance in the SDK and on the server. The new PageVariable will be automatically stored in the 'sourceVariable' property of the parent customwidgets.WidgetValue element passed as argument.

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

    Parameters

    Returns PageVariable

Generated using TypeDoc