Options
All
  • Public
  • Public/Protected
  • All
Menu

Class ConditionalVisibilitySettings

Hierarchy

Implements

Index

Constructors

constructor

Properties

attribute

attribute: IAttribute | null

attributeQualifiedName

attributeQualifiedName: string | null

conditions

conditions: IList<Condition>

container

container: AbstractElement

containerAsConditionallyEditableWidget

containerAsConditionallyEditableWidget: ConditionallyEditableWidget

containerAsConditionallyVisibleWidget

containerAsConditionallyVisibleWidget: ConditionallyVisibleWidget

containerAsControlBarButton

containerAsControlBarButton: ControlBarButton

containerAsCustomWidget

containerAsCustomWidget: CustomWidget

containerAsLayoutGridRow

containerAsLayoutGridRow: LayoutGridRow

containerAsNavigationListItem

containerAsNavigationListItem: NavigationListItem

containerAsTabPage

containerAsTabPage: TabPage

containerAsTableRow

containerAsTableRow: TableRow

expression

expression: string

The value of this property is conceptually of type microflowExpressions.MicroflowExpression.

In version 7.0.1: introduced

expressionModel

expressionModel: Expression

NOTE: This property is experimental and is subject to change in newer Model SDK versions.

In version 7.9.0: introduced

id

id: string

ignoreSecurity

ignoreSecurity: boolean

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

model

model: IModel

moduleRoles

moduleRoles: IList<IModuleRole>

moduleRolesQualifiedNames

moduleRolesQualifiedNames: string[]

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

Static createInConditionallyVisibleWidgetUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInControlBarButtonUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInCustomWidgetUnderConditionalVisibilitySettings

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

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInLayoutGridRowUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInNavigationListItemUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInTabPageUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Static createInTableRowUnderConditionalVisibilitySettings

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

    Parameters

    Returns ConditionalVisibilitySettings

Generated using TypeDoc