Options
All
  • Public
  • Public/Protected
  • All
Menu

Class Header

See: relevant section in reference guide

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

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

container

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

containerAsGroupBox

containerAsHeader

containerAsLayout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

containerAsListViewTemplate

containerAsMasterDetailRegion

  • get (): MasterDetailRegion

  • Returns MasterDetailRegion

containerAsNativeLayout

  • get (): NativeLayout

containerAsNativeLayoutCallArgument

  • get (): NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

  • Returns ReportPane

containerAsScrollContainerRegion

containerAsSnippet

containerAsSplitPane

containerAsTabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

  • Returns VerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

  • Returns WidgetValue

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

leftWidget

  • In version 7.15.0: deleted

    Returns Widget | null

  • In version 7.15.0: deleted

    Parameters

    Returns any

leftWidgets

model

name

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

  • Returns string

  • Parameters

    • newValue: string

    Returns any

rightWidget

  • In version 7.15.0: deleted

    Returns Widget | null

  • In version 7.15.0: deleted

    Parameters

    Returns any

rightWidgets

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

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

Static createInBuildingBlockUnderWidget

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

Static createInBuildingBlockUnderWidgets

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

Static createInDataViewUnderFooterWidget

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

    Parameters

    Returns Header

Static createInDataViewUnderFooterWidgets

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

Static createInDataViewUnderWidget

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

    Parameters

    Returns Header

Static createInDataViewUnderWidgets

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

Static createInDivContainerUnderWidget

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

    Parameters

    Returns Header

Static createInDivContainerUnderWidgets

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

Static createInGroupBoxUnderWidget

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

    Parameters

    Returns Header

Static createInGroupBoxUnderWidgets

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

Static createInHeaderUnderLeftWidget

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

    Parameters

    Returns Header

Static createInHeaderUnderLeftWidgets

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

Static createInHeaderUnderRightWidget

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

    Parameters

    Returns Header

Static createInHeaderUnderRightWidgets

  • createInHeaderUnderRightWidgets(container: Header): Header

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

Static createInLayoutCallArgumentUnderWidget

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

    Parameters

    Returns Header

Static createInLayoutCallArgumentUnderWidgets

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

Static createInLayoutGridColumnUnderWidget

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

    Parameters

    Returns Header

Static createInLayoutGridColumnUnderWidgets

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

Static createInLayoutUnderWidget

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

    Parameters

    Returns Header

Static createInLayoutUnderWidgets

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

Static createInListViewTemplateUnderWidget

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

    Parameters

    Returns Header

Static createInListViewTemplateUnderWidgets

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

Static createInListViewUnderWidget

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

    Parameters

    Returns Header

Static createInListViewUnderWidgets

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

Static createInMasterDetailRegionUnderWidget

  • createInMasterDetailRegionUnderWidget(container: MasterDetailRegion): Header

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

    • container: MasterDetailRegion

    Returns Header

Static createInNativeLayoutCallArgumentUnderWidgets

  • createInNativeLayoutCallArgumentUnderWidgets(container: NativeLayoutCallArgument): Header

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

    • container: NativeLayoutCallArgument

    Returns Header

Static createInNativeLayoutContentUnderSidebarWidgets

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

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

    Parameters

    Returns Header

Static createInNativeLayoutContentUnderWidgets

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

Static createInNativeLayoutUnderHeaderWidget

  • createInNativeLayoutUnderHeaderWidget(container: NativeLayout): Header

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

    • container: NativeLayout

    Returns Header

Static createInNativeLayoutUnderWidgets

  • createInNativeLayoutUnderWidgets(container: NativeLayout): Header

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

    • container: NativeLayout

    Returns Header

Static createInNavigationListItemUnderWidget

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

    Parameters

    Returns Header

Static createInNavigationListItemUnderWidgets

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

Static createInReportPaneUnderParameterWidget

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

Static createInReportPaneUnderReportWidget

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

Static createInScrollContainerRegionUnderWidget

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

    Parameters

    Returns Header

Static createInScrollContainerRegionUnderWidgets

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

Static createInSnippetUnderWidget

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

    Parameters

    Returns Header

Static createInSnippetUnderWidgets

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

Static createInSplitPaneUnderFirstWidget

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

    Parameters

    Returns Header

Static createInSplitPaneUnderFirstWidgets

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

Static createInSplitPaneUnderSecondWidget

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

    Parameters

    Returns Header

Static createInSplitPaneUnderSecondWidgets

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

Static createInTabPageUnderWidget

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

    Parameters

    Returns Header

Static createInTabPageUnderWidgets

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

Static createInTableCellUnderWidget

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

    Parameters

    Returns Header

Static createInTableCellUnderWidgets

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

Static createInTemplateGridContentsUnderWidget

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

    Parameters

    Returns Header

Static createInTemplateGridContentsUnderWidgets

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

Static createInVerticalFlowUnderWidgets

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

    Parameters

    Returns Header

Static createInWebLayoutContentUnderWidgets

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

Static createInWidgetValueUnderWidgets

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

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

    Parameters

    Returns Header

Generated using TypeDoc