Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientTemplate

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsButton

containerAsButton: Button

containerAsControlBarButton

containerAsControlBarButton: ControlBarButton

containerAsCustomWidget

containerAsCustomWidget: CustomWidget

containerAsDataGrid

containerAsDataGrid: DataGrid

containerAsDynamicText

containerAsDynamicText: DynamicText

containerAsGroupBox

containerAsGroupBox: GroupBox

containerAsInputWidget

containerAsInputWidget: InputWidget

containerAsWidgetObject

containerAsWidgetObject: WidgetObject

containerAsWidgetValue

containerAsWidgetValue: WidgetValue

fallback

fallback: Text

In version 8.3.0: introduced

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

parameters

structureTypeName

structureTypeName: string

template

template: Text

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

Methods

allProperties

asLoaded

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

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

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

findElementById

Protected getContainerAs

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

load

  • load(callback: function, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise
  • 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: ): void
        • Parameters

          • elem:

          Returns void

    • Optional forceRefresh: boolean

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise

loadedProperties

publicProperties

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

Static createInButtonUnderCaption

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

    Parameters

    Returns ClientTemplate

Static createInControlBarButtonUnderCaption

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

    Parameters

    Returns ClientTemplate

Static createInCustomWidgetUnderLabelTemplate

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

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

    Parameters

    Returns ClientTemplate

Static createInDataGridUnderCaption

  • Creates and returns a new ClientTemplate instance in the SDK and on the server. The new ClientTemplate will be automatically stored in the 'caption' property of the parent DataGrid 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 ClientTemplate

Static createInDynamicTextUnderContent

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

    Parameters

    Returns ClientTemplate

Static createInGroupBoxUnderCaption

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

    Parameters

    Returns ClientTemplate

Static createInInputWidgetUnderLabelTemplate

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

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

    Parameters

    Returns ClientTemplate

Static createInWidgetObjectUnderLabelTemplate

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

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

    Parameters

    Returns ClientTemplate

Static createInWidgetValueUnderTextTemplate

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

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

    Parameters

    Returns ClientTemplate

Generated using TypeDoc