Options
All
  • Public
  • Public/Protected
  • All
Menu

Class PageSettings

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsAssociationWidget

containerAsAssociationWidget: AssociationWidget

containerAsCreateObjectClientAction

containerAsCreateObjectClientAction: CreateObjectClientAction

containerAsDataGridAddButton

containerAsDataGridAddButton: DataGridAddButton

containerAsGridEditButton

containerAsGridEditButton: GridEditButton

containerAsGridNewButton

containerAsGridNewButton: GridNewButton

containerAsNavigationProfile

containerAsNavigationProfile: NavigationProfile

containerAsNewButton

containerAsNewButton: NewButton

containerAsPageClientAction

containerAsPageClientAction: PageClientAction

containerAsPageForSpecialization

containerAsPageForSpecialization: PageForSpecialization

containerAsReferenceSelector

containerAsReferenceSelector: ReferenceSelector

containerAsShowPageAction

containerAsShowPageAction: ShowPageAction

formTitle

formTitle: Text | null

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

location

location: FormLocation

In version 8.0.0: deleted

model

model: IModel

page

page: IPage | null

pageQualifiedName

pageQualifiedName: string | null

structureTypeName

structureTypeName: string

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

Static createInAssociationWidgetUnderSelectPageSettings

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

    Parameters

    Returns PageSettings

Static createInCreateObjectClientActionUnderPageSettings

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

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

    Parameters

    Returns PageSettings

Static createInDataGridAddButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInGridEditButtonUnderPageSettings

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

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

    Parameters

    Returns PageSettings

Static createInGridNewButtonUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInNavigationProfileUnderLoginPageSettings

  • Creates and returns a new PageSettings instance in the SDK and on the server. The new PageSettings will be automatically stored in the 'loginPageSettings' property of the parent navigation.NavigationProfile element passed as argument.

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

    Parameters

    Returns PageSettings

Static createInNewButtonUnderPageSettings

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

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

    Parameters

    Returns PageSettings

Static createInPageClientActionUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInPageForSpecializationUnderPageSettings

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

    Parameters

    Returns PageSettings

Static createInReferenceSelectorUnderGotoPageSettings

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

    Parameters

    Returns PageSettings

Static createInShowPageActionUnderPageSettings

  • Creates and returns a new PageSettings instance in the SDK and on the server. The new PageSettings will be automatically stored in the 'pageSettings' property of the parent microflows.ShowPageAction element passed as argument.

    Parameters

    Returns PageSettings

Generated using TypeDoc