Options
All
  • Public
  • Public/Protected
  • All
Menu

Class TemplatePlaceholder

In version 8.13.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns any

class

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

container

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

  • Returns MasterDetailRegion

containerAsNativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

  • Returns ReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

  • Returns VerticalFlow

containerAsWebLayoutContent

  • Returns WebLayoutContent

containerAsWidgetValue

  • Returns WidgetValue

isLoaded

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

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

    Returns boolean

model

name

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

  • Parameters

    • newValue: string

    Returns any

style

  • get (): string
  • set (newValue: string): any
  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns any

tabIndex

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

  • Parameters

    • newValue: number

    Returns any

type

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

  • Parameters

    • newValue: string

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

Static createInBuildingBlockUnderWidgets

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

Static createInDataViewUnderFooterWidgets

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

Static createInDataViewUnderWidgets

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

Static createInDivContainerUnderWidgets

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

Static createInGroupBoxUnderWidgets

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

Static createInHeaderUnderLeftWidgets

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

Static createInHeaderUnderRightWidgets

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

Static createInLayoutCallArgumentUnderWidgets

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

Static createInLayoutGridColumnUnderWidgets

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

Static createInListViewTemplateUnderWidgets

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

Static createInListViewUnderWidgets

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

Static createInNativeLayoutContentUnderSidebarWidgets

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

Static createInNativeLayoutContentUnderWidgets

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

Static createInNavigationListItemUnderWidgets

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

Static createInScrollContainerRegionUnderWidgets

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

Static createInSnippetUnderWidgets

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

Static createInTabPageUnderWidgets

  • Creates and returns a new TemplatePlaceholder instance in the SDK and on the server. The new TemplatePlaceholder will be automatically stored in the 'widgets' 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 TemplatePlaceholder

Static createInTableCellUnderWidgets

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

Static createInTemplateGridContentsUnderWidgets

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

Static createInWebLayoutContentUnderWidgets

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

Static createInWidgetValueUnderWidgets

  • Creates and returns a new TemplatePlaceholder instance in the SDK and on the server. The new TemplatePlaceholder will be automatically stored in the 'widgets' 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.13.0 and higher

    Parameters

    Returns TemplatePlaceholder

Generated using TypeDoc