Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncClientAction

In version 7.0.2: introduced

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

containerAsActionButton

containerAsActionItem

containerAsAssociationWidget

containerAsAttributeWidget

containerAsBottomBarItem

  • get (): BottomBarItem

  • Returns BottomBarItem

containerAsDataViewActionButton

containerAsDivContainer

  • Returns DivContainer

containerAsDynamicImageViewer

containerAsGridActionButton

containerAsListView

containerAsMenuItem

containerAsReferenceSetSelector

containerAsStaticImageViewer

containerAsTextBox

  • Returns TextBox

containerAsWidgetValue

disabledDuringExecution

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

  • In version 8.12.0: introduced

    Returns boolean

  • In version 8.12.0: introduced

    Parameters

    • newValue: boolean

    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

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

Static createInActionButtonUnderAction

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

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

    Parameters

    Returns SyncClientAction

Static createInActionItemUnderAction

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

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

    Parameters

    Returns SyncClientAction

Static createInAssociationWidgetUnderOnChangeAction

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

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

    Parameters

    Returns SyncClientAction

Static createInAttributeWidgetUnderOnChangeAction

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

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

    Parameters

    Returns SyncClientAction

Static createInAttributeWidgetUnderOnEnterAction

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

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

    Parameters

    Returns SyncClientAction

Static createInAttributeWidgetUnderOnLeaveAction

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

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

    Parameters

    Returns SyncClientAction

Static createInBottomBarItemUnderAction

  • Creates and returns a new SyncClientAction instance in the SDK and on the server. The new SyncClientAction will be automatically stored in the 'action' property of the parent nativepages.BottomBarItem element passed as argument.

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

    Parameters

    • container: BottomBarItem

    Returns SyncClientAction

Static createInDivContainerUnderOnClickAction

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

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

    Parameters

    Returns SyncClientAction

Static createInDynamicImageViewerUnderClickAction

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

Static createInGridActionButtonUnderAction

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

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

    Parameters

    Returns SyncClientAction

Static createInListViewUnderClickAction

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

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

    Parameters

    Returns SyncClientAction

Static createInListViewUnderPullDownAction

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

Static createInMenuItemUnderAction

  • Creates and returns a new SyncClientAction instance in the SDK and on the server. The new SyncClientAction 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.0.2 and higher

    Parameters

    Returns SyncClientAction

Static createInReferenceSetSelectorUnderOnChangeAction

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

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

    Parameters

    Returns SyncClientAction

Static createInStaticImageViewerUnderClickAction

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

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

    Parameters

    Returns SyncClientAction

Static createInTextBoxUnderOnEnterKeyPressAction

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

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

    Parameters

    Returns SyncClientAction

Static createInWidgetValueUnderAction

  • Creates and returns a new SyncClientAction instance in the SDK and on the server. The new SyncClientAction 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.19.0 and higher

    Parameters

    Returns SyncClientAction

Generated using TypeDoc