Options
All
  • Public
  • Public/Protected
  • All
Menu

Class CustomWidget

Interfaces and instance classes for types from the Mendix sub meta model CustomWidgets.

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

appearance

appearance: Appearance

In version 8.0.0: introduced

class

class: string

In version 8.0.0: deleted

conditionalEditabilitySettings

conditionalEditabilitySettings: ConditionalEditabilitySettings | null

In version 8.1.0: introduced

conditionalVisibilitySettings

conditionalVisibilitySettings: ConditionalVisibilitySettings | null

In version 8.1.0: introduced

container

container: AbstractElement

containerAsBuildingBlock

containerAsBuildingBlock: BuildingBlock

containerAsDataView

containerAsDataView: DataView

containerAsDivContainer

containerAsDivContainer: DivContainer

containerAsGroupBox

containerAsGroupBox: GroupBox

containerAsHeader

containerAsHeader: Header

containerAsLayout

containerAsLayout: Layout

containerAsLayoutCallArgument

containerAsLayoutCallArgument: LayoutCallArgument

containerAsLayoutGridColumn

containerAsLayoutGridColumn: LayoutGridColumn

containerAsListView

containerAsListView: ListView

containerAsListViewTemplate

containerAsListViewTemplate: ListViewTemplate

containerAsMasterDetailRegion

containerAsMasterDetailRegion: MasterDetailRegion

containerAsNativeLayout

containerAsNativeLayout: NativeLayout

containerAsNativeLayoutCallArgument

containerAsNativeLayoutCallArgument: NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNativeLayoutContent: NativeLayoutContent

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsReportPane

containerAsReportPane: ReportPane

containerAsScrollContainerRegion

containerAsScrollContainerRegion: ScrollContainerRegion

containerAsSnippet

containerAsSnippet: Snippet

containerAsSplitPane

containerAsSplitPane: SplitPane

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableCell

containerAsTableCell: TableCell

containerAsTemplateGridContents

containerAsTemplateGridContents: TemplateGridContents

containerAsVerticalFlow

containerAsVerticalFlow: VerticalFlow

containerAsWebLayoutContent

containerAsWebLayoutContent: WebLayoutContent

editable

editable: EditableEnum

In version 8.1.0: introduced

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

labelTemplate

labelTemplate: ClientTemplate | null

In version 8.1.0: introduced

model

model: IModel

name

name: string

object

object: WidgetObject | null

structureTypeName

structureTypeName: string

style

style: string

In version 8.0.0: deleted

tabIndex

tabIndex: number

type

type: CustomWidgetType | null

unit

unit: ModelUnit

Static structureTypeName

structureTypeName: string

Static versionInfo

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

Static createInBuildingBlockUnderWidget

  • Creates and returns a new CustomWidget instance in the SDK and on the server. The new CustomWidget will be automatically stored in the 'widget' 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.7.0 to 7.14.0

    Parameters

    Returns CustomWidget

Static createInBuildingBlockUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInDataViewUnderFooterWidget

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

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

    Parameters

    Returns CustomWidget

Static createInDataViewUnderFooterWidgets

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

    Parameters

    Returns CustomWidget

Static createInDataViewUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInDataViewUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInDivContainerUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInDivContainerUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInGroupBoxUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInGroupBoxUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInHeaderUnderLeftWidget

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

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

    Parameters

    Returns CustomWidget

Static createInHeaderUnderLeftWidgets

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

    Parameters

    Returns CustomWidget

Static createInHeaderUnderRightWidget

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

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

    Parameters

    Returns CustomWidget

Static createInHeaderUnderRightWidgets

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

    Parameters

    Returns CustomWidget

Static createInLayoutCallArgumentUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInLayoutCallArgumentUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInLayoutGridColumnUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInLayoutGridColumnUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInLayoutUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInLayoutUnderWidgets

  • Creates and returns a new CustomWidget instance in the SDK and on the server. The new CustomWidget 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.15.0 to 7.23.0

    Parameters

    Returns CustomWidget

Static createInListViewTemplateUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInListViewTemplateUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInListViewUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInListViewUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInMasterDetailRegionUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInNativeLayoutCallArgumentUnderWidgets

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

Static createInNativeLayoutContentUnderWidgets

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

Static createInNativeLayoutUnderHeaderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInNativeLayoutUnderWidgets

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

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

    Parameters

    Returns CustomWidget

Static createInNavigationListItemUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInNavigationListItemUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInReportPaneUnderParameterWidget

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

Static createInReportPaneUnderReportWidget

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

Static createInScrollContainerRegionUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInScrollContainerRegionUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInSnippetUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInSnippetUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInSplitPaneUnderFirstWidget

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

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

    Parameters

    Returns CustomWidget

Static createInSplitPaneUnderFirstWidgets

  • Creates and returns a new CustomWidget instance in the SDK and on the server. The new CustomWidget 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.15.0 to 7.23.0

    Parameters

    Returns CustomWidget

Static createInSplitPaneUnderSecondWidget

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

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

    Parameters

    Returns CustomWidget

Static createInSplitPaneUnderSecondWidgets

  • Creates and returns a new CustomWidget instance in the SDK and on the server. The new CustomWidget 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.15.0 to 7.23.0

    Parameters

    Returns CustomWidget

Static createInTabPageUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInTabPageUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInTableCellUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInTableCellUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInTemplateGridContentsUnderWidget

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

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

    Parameters

    Returns CustomWidget

Static createInTemplateGridContentsUnderWidgets

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

    Parameters

    Returns CustomWidget

Static createInVerticalFlowUnderWidgets

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

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

    Parameters

    Returns CustomWidget

Static createInWebLayoutContentUnderWidgets

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

Generated using TypeDoc