Options
All
  • Public
  • Public/Protected
  • All
Menu

Class StringTemplate

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

arguments

container

containerAsAbortOperation

  • get (): AbortOperation

containerAsCustomRequestHandling

containerAsHttpConfiguration

containerAsLogMessageAction

containerAsPageSettings

containerAsShowMessageAction

containerAsStringTemplateParameterValue

containerAsUserTask

containerAsValidationFeedbackAction

containerAsWorkflow

isLoaded

  • get (): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

model

text

  • get (): string
  • set (newValue: string): any

  • Returns string

  • Parameters

    • newValue: string

    Returns any

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

Static createInAbortOperationUnderReason

  • createInAbortOperationUnderReason(container: AbortOperation): StringTemplate

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

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

    Parameters

    • container: AbortOperation

    Returns StringTemplate

Static createInCustomRequestHandlingUnderTemplate

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

    Parameters

    Returns StringTemplate

Static createInHttpConfigurationUnderCustomLocationTemplate

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

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

    Parameters

    Returns StringTemplate

Static createInLogMessageActionUnderMessageTemplate

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

    Parameters

    Returns StringTemplate

Static createInStringTemplateParameterValueUnderTemplate

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

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

    Parameters

    Returns StringTemplate

Static createInUserTaskUnderTaskDescription

  • Creates and returns a new StringTemplate instance in the SDK and on the server. The new StringTemplate will be automatically stored in the 'taskDescription' property of the parent workflows.UserTask element passed as argument.

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

    Parameters

    Returns StringTemplate

Static createInUserTaskUnderTaskName

  • Creates and returns a new StringTemplate instance in the SDK and on the server. The new StringTemplate will be automatically stored in the 'taskName' property of the parent workflows.UserTask element passed as argument.

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

    Parameters

    Returns StringTemplate

Static createInWorkflowUnderWorkflowDescription

  • Creates and returns a new StringTemplate instance in the SDK and on the server. The new StringTemplate will be automatically stored in the 'workflowDescription' property of the parent workflows.Workflow element passed as argument.

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

    Parameters

    Returns StringTemplate

Static createInWorkflowUnderWorkflowName

  • Creates and returns a new StringTemplate instance in the SDK and on the server. The new StringTemplate will be automatically stored in the 'workflowName' property of the parent workflows.Workflow element passed as argument.

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

    Parameters

    Returns StringTemplate

Generated using TypeDoc