Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ClientTemplate

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

containerAsButton

containerAsControlBarButton

containerAsCustomWidget

containerAsDataGrid

containerAsDynamicImageViewer

containerAsDynamicText

containerAsGroupBox

containerAsInputWidget

containerAsStaticImageViewer

containerAsTabPage

containerAsWidgetObject

containerAsWidgetValue

fallback

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

  • In version 8.3.0: introduced

    Returns Text

  • In version 8.3.0: introduced

    Parameters

    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

parameters

template

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

  • Returns Text

  • Parameters

    Returns any

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

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.6.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 createInInputWidgetUnderScreenReaderLabel

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

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

    Parameters

    Returns ClientTemplate

Static createInStaticImageViewerUnderAlternativeText

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

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

    Parameters

    Returns ClientTemplate

Static createInTabPageUnderBadge

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

    Warning! Can only be used on models with the following Mendix meta model versions: 8.13.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