Options
All
  • Public
  • Public/Protected
  • All
Menu

Class VerticalFlow

In version 7.15.0: deleted

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Pages$VerticalFlow"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

appearance

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns void

class

  • get class(): string
  • set class(newValue: string): void

  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

container

  • get container(): TContainer

  • Returns TContainer

containerAsBuildingBlock

containerAsDataView

containerAsDivContainer

  • Returns DivContainer

containerAsGroupBox

  • Returns GroupBox

containerAsHeader

containerAsLayout

  • get containerAsLayout(): Layout

  • Returns Layout

containerAsLayoutCallArgument

containerAsLayoutGridColumn

containerAsListView

  • Returns ListView

containerAsListViewTemplate

containerAsMasterDetailRegion

  • get containerAsMasterDetailRegion(): MasterDetailRegion

  • Returns MasterDetailRegion

containerAsNativeLayout

  • get containerAsNativeLayout(): NativeLayout

  • Returns NativeLayout

containerAsNativeLayoutCallArgument

  • get containerAsNativeLayoutCallArgument(): NativeLayoutCallArgument

  • Returns NativeLayoutCallArgument

containerAsNativeLayoutContent

containerAsNavigationListItem

containerAsReportPane

  • Returns ReportPane

containerAsScrollContainerRegion

containerAsSnippet

  • Returns Snippet

containerAsSplitPane

  • Returns SplitPane

containerAsTabPage

  • Returns TabPage

containerAsTableCell

containerAsTemplateGridContents

containerAsVerticalFlow

  • Returns VerticalFlow

containerAsWebLayoutContent

containerAsWidgetValue

  • Returns WidgetValue

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

model

  • get model(): TModel

  • Returns TModel

name

  • get name(): string
  • set name(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

style

  • get style(): string
  • set style(newValue: string): void

  • In version 8.0.0: deleted

    Returns string

  • In version 8.0.0: deleted

    Parameters

    • newValue: string

    Returns void

tabIndex

  • get tabIndex(): number
  • set tabIndex(newValue: number): void

  • Returns number

  • Parameters

    • newValue: number

    Returns void

unit

widgets

Methods

allProperties

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.

    Returns VerticalFlow

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

  • Deletes this element from the model.

    Returns void

detach

  • Detaches this element from the model, so that it can be attached in a different place.

    Returns VerticalFlow

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • load(callback: (elem: VerticalFlow) => void, forceRefresh?: boolean): void
  • load(forceRefresh?: boolean): Promise<VerticalFlow>

  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<VerticalFlow>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

  • Traverses this structure, returning immediately when visit returns something other than null.

    Type parameters

    • T

    Parameters

    Returns null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): void

Static create

  • Creates and returns a new VerticalFlow 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

    • model: IModel

    Returns VerticalFlow

Static createInBuildingBlockUnderWidget

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

Static createInDataViewUnderFooterWidget

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

Static createInDataViewUnderWidget

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

Static createInDivContainerUnderWidget

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

Static createInGroupBoxUnderWidget

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

Static createInHeaderUnderLeftWidget

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

Static createInHeaderUnderRightWidget

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

Static createInLayoutCallArgumentUnderWidget

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

Static createInLayoutGridColumnUnderWidget

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

Static createInLayoutUnderWidget

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

Static createInListViewTemplateUnderWidget

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

Static createInListViewUnderWidget

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

Static createInMasterDetailRegionUnderWidget

  • createInMasterDetailRegionUnderWidget(container: MasterDetailRegion): VerticalFlow

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

Static createInNavigationListItemUnderWidget

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

Static createInReportPaneUnderParameterWidget

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

Static createInReportPaneUnderReportWidget

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

Static createInScrollContainerRegionUnderWidget

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

Static createInSnippetUnderWidget

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

Static createInSplitPaneUnderFirstWidget

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

Static createInSplitPaneUnderSecondWidget

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

Static createInTabPageUnderWidget

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

Static createInTableCellUnderWidget

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

Static createInTemplateGridContentsUnderWidget

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

Static createInVerticalFlowUnderWidgets

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

Generated using TypeDoc