Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenerateDocumentAction

Hierarchy

Implements

Index

Constructors

constructor

Properties

container

container: AbstractElement

containerAsActionActivity

containerAsActionActivity: ActionActivity

documentTemplate

documentTemplate: IDocumentTemplate | null

documentTemplateQualifiedName

documentTemplateQualifiedName: string | null

documentType

documentType: TargetDocumentType

errorHandlingType

errorHandlingType: ErrorHandlingType

fileVariableName

fileVariableName: string

id

id: string

isLoaded

isLoaded: boolean

Checks whether all attributes are available ATM

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

languageSetting

languageSetting: LanguageSettingType

languageVariableName

languageVariableName: string

marginBottomInInch

marginBottomInInch: string

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

marginBottomInInchModel

marginBottomInInchModel: Expression

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

In version 7.9.0: introduced

marginLeftInInch

marginLeftInInch: string

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

marginLeftInInchModel

marginLeftInInchModel: Expression

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

In version 7.9.0: introduced

marginRightInInch

marginRightInInch: string

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

marginRightInInchModel

marginRightInInchModel: Expression

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

In version 7.9.0: introduced

marginTopInInch

marginTopInInch: string

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

marginTopInInchModel

marginTopInInchModel: Expression

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

In version 7.9.0: introduced

model

model: IModel

overrideBottomMargin

overrideBottomMargin: boolean

overrideLeftMargin

overrideLeftMargin: boolean

overrideRightMargin

overrideRightMargin: boolean

overrideTopMargin

overrideTopMargin: boolean

parameterMappings

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

Static createIn

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

    Parameters

    Returns GenerateDocumentAction

Generated using TypeDoc