Options
All
  • Public
  • Public/Protected
  • All
Menu

Class SyncButton

In version 7.0.2: deleted

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

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns any

buttonStyle

caption

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

conditionalVisibilitySettings

container

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

  • get (): MasterDetailRegion

containerAsNativeLayout

  • get (): NativeLayout

containerAsNativeLayoutCallArgument

  • get (): NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

icon

  • get (): Icon | null
  • set (newValue: Icon | null): any

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

renderType

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

tooltip

  • get (): Text
  • set (newValue: Text): 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 SyncButton 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 SyncButton

Static createInDataViewUnderFooterWidget

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

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

    Parameters

    Returns SyncButton

Static createInDataViewUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInDivContainerUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInGroupBoxUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInHeaderUnderLeftWidget

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

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

    Parameters

    Returns SyncButton

Static createInHeaderUnderRightWidget

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

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

    Parameters

    Returns SyncButton

Static createInLayoutCallArgumentUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInLayoutGridColumnUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInLayoutUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInListViewTemplateUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInListViewUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInNavigationListItemUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInReportPaneUnderParameterWidget

  • Creates and returns a new SyncButton instance in the SDK and on the server. The new SyncButton will be automatically stored in the 'parameterWidget' property of the parent reports.ReportPane element passed as argument.

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

    Parameters

    Returns SyncButton

Static createInReportPaneUnderReportWidget

  • Creates and returns a new SyncButton instance in the SDK and on the server. The new SyncButton will be automatically stored in the 'reportWidget' property of the parent reports.ReportPane element passed as argument.

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

    Parameters

    Returns SyncButton

Static createInScrollContainerRegionUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInSnippetUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInSplitPaneUnderFirstWidget

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

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

    Parameters

    Returns SyncButton

Static createInSplitPaneUnderSecondWidget

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

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

    Parameters

    Returns SyncButton

Static createInTabPageUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInTableCellUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInTemplateGridContentsUnderWidget

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

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

    Parameters

    Returns SyncButton

Static createInVerticalFlowUnderWidgets

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

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

    Parameters

    Returns SyncButton

Generated using TypeDoc