Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NativePlaceholder

NOTE: This class is experimental and is subject to change in newer Model SDK versions.

In version 8.0.0: deleted In version 7.23.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

container

container: AbstractElement

id

id: string

model

model: IModel

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string

Static versionInfo

Accessors

appearance

class

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

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

containerAsNativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

isLoaded

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

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

    Returns boolean

name

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

style

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

tabIndex

  • get (): number
  • set (newValue: number): 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 NativePlaceholder 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 NativePlaceholder

Static createInBuildingBlockUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.BuildingBlock element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInDataViewUnderFooterWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'footerWidgets' property of the parent pages.DataView element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInDataViewUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.DataView element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInDivContainerUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.DivContainer element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInGroupBoxUnderWidgets

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

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

    Parameters

    Returns NativePlaceholder

Static createInHeaderUnderLeftWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'leftWidgets' property of the parent pages.Header element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInHeaderUnderRightWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'rightWidgets' property of the parent pages.Header element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInLayoutCallArgumentUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.LayoutCallArgument element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInLayoutGridColumnUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.LayoutGridColumn element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInLayoutUnderWidgets

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

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

    Parameters

    Returns NativePlaceholder

Static createInListViewTemplateUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.ListViewTemplate element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInListViewUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.ListView element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInNativeLayoutCallArgumentUnderWidgets

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

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

    Parameters

    Returns NativePlaceholder

Static createInNativeLayoutUnderHeaderWidget

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

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

    Parameters

    Returns NativePlaceholder

Static createInNativeLayoutUnderWidgets

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

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

    Parameters

    Returns NativePlaceholder

Static createInNavigationListItemUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.NavigationListItem element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInScrollContainerRegionUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.ScrollContainerRegion element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInSnippetUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.Snippet element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInSplitPaneUnderFirstWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'firstWidgets' property of the parent pages.SplitPane element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInSplitPaneUnderSecondWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'secondWidgets' property of the parent pages.SplitPane element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInTabPageUnderWidgets

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

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

    Parameters

    Returns NativePlaceholder

Static createInTableCellUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.TableCell element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Static createInTemplateGridContentsUnderWidgets

  • Creates and returns a new NativePlaceholder instance in the SDK and on the server. The new NativePlaceholder will be automatically stored in the 'widgets' property of the parent pages.TemplateGridContents element passed as argument.

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

    Parameters

    Returns NativePlaceholder

Generated using TypeDoc