Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenerateDocumentAction

See: relevant section in reference guide

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Properties

Private ___documentTemplate

___documentTemplate: any

Private ___documentType

___documentType: any

Private ___fileVariableName

___fileVariableName: any

Private ___languageSetting

___languageSetting: any

Private ___languageVariableName

___languageVariableName: any

Private ___marginBottomInInch

___marginBottomInInch: any

Private ___marginLeftInInch

___marginLeftInInch: any

Private ___marginRightInInch

___marginRightInInch: any

Private ___marginTopInInch

___marginTopInInch: any

Private ___overrideBottomMargin

___overrideBottomMargin: any

Private ___overrideLeftMargin

___overrideLeftMargin: any

Private ___overrideRightMargin

___overrideRightMargin: any

Private ___overrideTopMargin

___overrideTopMargin: any

Private ___parameterMappings

___parameterMappings: any

container

container: AbstractElement

containerAsActionActivity

containerAsActionActivity: ActionActivity

documentTemplate

documentTemplate: IDocumentTemplate

documentTemplateQualifiedName

documentTemplateQualifiedName: string

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.

marginLeftInInch

marginLeftInInch: string

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

marginRightInInch

marginRightInInch: string

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

marginTopInInch

marginTopInInch: string

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

model

model: IModel

overrideBottomMargin

overrideBottomMargin: boolean

overrideLeftMargin

overrideLeftMargin: boolean

overrideRightMargin

overrideRightMargin: boolean

overrideTopMargin

overrideTopMargin: boolean

parameterMappings

parameterMappings: IList<DocumentTemplateParameterMapping>

qualifiedName

qualifiedName: string

Calculates the fully qualified name of this element, by visiting all parents that have $isNamespace set to true.

typeName

typeName: string

unit

unit: ModelUnit

versionInfo

versionInfo: StructureVersionInfo

Static typeName

typeName: string

Static versionInfo

versionInfo: StructureVersionInfo

Methods

Protected _scheduleDeltaAfterCreate

  • _scheduleDeltaAfterCreate(delta: IDelta): void

Protected _sendDeleteDelta

  • _sendDeleteDelta(): void

Protected _updateElementsContainer

  • _updateElementsContainer(unit: ModelUnit): void

  • updateElementsContainer recursively sets the unit to which this elements belong During deserialization this is not needed, but if used in the SDK, we only can set the unit once an element is actually added to the tree (buy pushing / assigning it to some part property)

    Parameters

    Returns void

Protected _updateWithJsonImpl

allProperties

deepCopyInto

delete

  • delete(): void

Protected getContainerAs

load

  • load<T>(callback: function, forceRefresh?: boolean): any
  • load<T>(): T

  • 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.

    Type parameters

    Parameters

    • callback: function
        • (elem: T): void

        • Parameters

          • elem: T

          Returns void

    • Optional forceRefresh: boolean

    Returns any

  • Type parameters

    Returns T

toJSON

  • toJSON(): Object

traverse

  • traverse(visit: function): void

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