Options
All
  • Public
  • Public/Protected
  • All
Menu

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

Properties

id: string
structureTypeName: string
structureTypeName: string = "Pages$TemplateGrid"
versionInfo: StructureVersionInfo = ...

Accessors

  • In version 9.24.0: deleted In version 9.22.0: introduced

    Returns null | AccessibilitySettings

  • In version 9.24.0: deleted In version 9.22.0: introduced

    Parameters

    Returns void

  • In version 8.0.0: introduced

    Returns Appearance

  • In version 8.0.0: introduced

    Parameters

    Returns void

  • 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

  • get container(): TContainer
  • Returns TContainer

  • Returns GroupBox

  • get containerAsLayout(): Layout
  • Returns Layout

  • Returns ListView

  • get containerAsMasterDetailRegion(): MasterDetailRegion
  • Returns MasterDetailRegion

  • get containerAsNativeLayout(): NativeLayout
  • Returns NativeLayout

  • get containerAsNativeLayoutCallArgument(): NativeLayoutCallArgument
  • Returns NativeLayoutCallArgument

  • Returns ReportPane

  • Returns Snippet

  • Returns SplitPane

  • Returns TabPage

  • Returns WidgetValue

  • Returns DataSource

  • Parameters

    Returns void

  • Returns ClickTypeType

  • Parameters

    Returns void

  • get isControlBarVisible(): boolean
  • set isControlBarVisible(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • get isLoaded(): boolean
  • Checks whether all attributes are available ATM

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

    Returns boolean

  • get isPagingEnabled(): boolean
  • set isPagingEnabled(newValue: boolean): void
  • In version 8.13.0: deleted

    Returns boolean

  • In version 8.13.0: deleted

    Parameters

    • newValue: boolean

    Returns void

  • get model(): TModel
  • Returns TModel

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

  • Parameters

    • newValue: string

    Returns void

  • get numberOfColumns(): number
  • set numberOfColumns(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get numberOfRows(): number
  • set numberOfRows(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get refreshTime(): number
  • set refreshTime(newValue: number): void
  • Returns number

  • Parameters

    • newValue: number

    Returns void

  • get selectFirst(): boolean
  • set selectFirst(newValue: boolean): void
  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

  • In version 8.13.0: introduced

    Returns ShowPagingBarType

  • In version 8.13.0: introduced

    Parameters

    Returns void

  • 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

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

  • Parameters

    • newValue: number

    Returns void

Methods

  • 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 pages.TemplateGrid

  • delete(): void
  • Deletes this element from the model.

    Returns void

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

    Returns pages.TemplateGrid

  • getContainerAs<T>(containerType: any): T
  • 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<pages.TemplateGrid>

  • 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(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<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(visit: (structure: IStructure) => void): void
  • Creates and returns a new TemplateGrid 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 pages.TemplateGrid

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

  • createInMasterDetailRegionUnderWidget(container: MasterDetailRegion): pages.TemplateGrid
  • Creates and returns a new TemplateGrid instance in the SDK and on the server. The new TemplateGrid 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 pages.TemplateGrid

  • createInNativeLayoutCallArgumentUnderWidgets(container: NativeLayoutCallArgument): pages.TemplateGrid
  • Creates and returns a new TemplateGrid instance in the SDK and on the server. The new TemplateGrid 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 pages.TemplateGrid

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

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

Generated using TypeDoc