Options
All
  • Public
  • Public/Protected
  • All
Menu

Class AttributeRef

In version 9.6.0: added public In version 7.11.0: introduced

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

attribute

attributeQualifiedName

  • get (): string

  • Returns string

container

containerAsAttributeWidget

containerAsClientTemplateParameter

containerAsDataGridColumn

containerAsDocumentTemplatesGridSortItem

containerAsGridColumn

containerAsListViewSearch

containerAsMemberWidget

containerAsPagesGridSortItem

containerAsRangeSearchField

containerAsSingleSearchField

containerAsSortItem

containerAsStaticOrDynamicString

containerAsVariableRefExpression

  • get (): VariableRefExpression

containerAsWidgetValue

entityRef

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

model

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

Static createInAttributeWidgetUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent documenttemplates.AttributeWidget element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInClientTemplateParameterUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.ClientTemplateParameter element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInDataGridColumnUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent documenttemplates.DataGridColumn element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInDocumentTemplatesGridSortItemUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent documenttemplates.GridSortItem element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInGridColumnUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.GridColumn element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInListViewSearchUnderSearchRefs

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'searchRefs' property of the parent pages.ListViewSearch element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInMemberWidgetUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.MemberWidget element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInPagesGridSortItemUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.GridSortItem element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInRangeSearchFieldUnderLowerBoundRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'lowerBoundRef' property of the parent pages.RangeSearchField element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInRangeSearchFieldUnderUpperBoundRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'upperBoundRef' property of the parent pages.RangeSearchField element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInSingleSearchFieldUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.SingleSearchField element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInSortItemUnderAttributeRef

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

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

    Parameters

    Returns AttributeRef

Static createInStaticOrDynamicStringUnderAttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'attributeRef' property of the parent pages.StaticOrDynamicString element passed as argument.

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

    Parameters

    Returns AttributeRef

Static createInVariableRefExpressionUnderMember

  • createInVariableRefExpressionUnderMember(container: VariableRefExpression): AttributeRef

  • Creates and returns a new AttributeRef instance in the SDK and on the server. The new AttributeRef will be automatically stored in the 'member' property of the parent expressions.VariableRefExpression element passed as argument.

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

    Parameters

    • container: VariableRefExpression

    Returns AttributeRef

Static createInWidgetValueUnderAttributeRef

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

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

    Parameters

    Returns AttributeRef

Generated using TypeDoc