Options
All
  • Public
  • Public/Protected
  • All
Menu

Class NativePageClientAction

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

In version 7.23.0: introduced

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

container

container: AbstractElement

containerAsActionButton

containerAsActionButton: ActionButton

containerAsActionItem

containerAsActionItem: ActionItem

containerAsActionValue

containerAsActionValue: ActionValue

containerAsAssociationWidget

containerAsAssociationWidget: AssociationWidget

containerAsAttributeWidget

containerAsAttributeWidget: AttributeWidget

containerAsDataViewActionButton

containerAsDataViewActionButton: DataViewActionButton

containerAsDynamicImageViewer

containerAsDynamicImageViewer: DynamicImageViewer

containerAsGridActionButton

containerAsGridActionButton: GridActionButton

containerAsListView

containerAsListView: ListView

containerAsMenuItem

containerAsMenuItem: MenuItem

containerAsReferenceSetSelector

containerAsReferenceSetSelector: ReferenceSetSelector

containerAsStaticImageViewer

containerAsStaticImageViewer: StaticImageViewer

containerAsWidgetValue

containerAsWidgetValue: WidgetValue

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

page

page: INativePage | null

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

pageQualifiedName

pageQualifiedName: string | null

structureTypeName

structureTypeName: string

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

versionInfo: StructureVersionInfo

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

Static createInActionButtonUnderAction

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

Static createInActionItemUnderAction

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

Static createInAssociationWidgetUnderOnChangeAction

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

Static createInAttributeWidgetUnderOnChangeAction

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

Static createInAttributeWidgetUnderOnEnterAction

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

Static createInAttributeWidgetUnderOnLeaveAction

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

Static createInDynamicImageViewerUnderClickAction

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

Static createInGridActionButtonUnderAction

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

Static createInListViewUnderClickAction

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

    Parameters

    Returns NativePageClientAction

Static createInMenuItemUnderAction

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

Static createInReferenceSetSelectorUnderOnChangeAction

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

Static createInStaticImageViewerUnderClickAction

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

Static createInWidgetValueUnderAction

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

Generated using TypeDoc