Options
All
  • Public
  • Public/Protected
  • All
Menu

Class GenerateDocumentAction

See: relevant section in reference guide

Hierarchy

Index

Constructors

Properties

Accessors

Methods

Constructors

constructor

Properties

id

id: string

structureTypeName

structureTypeName: string

Static structureTypeName

structureTypeName: string = "Microflows$GenerateDocumentAction"

Static versionInfo

versionInfo: StructureVersionInfo = ...

Accessors

container

  • get container(): TContainer

  • Returns TContainer

containerAsActionActivity

  • Returns ActionActivity

documentTemplate

documentTemplateQualifiedName

  • get documentTemplateQualifiedName(): null | string

  • Returns null | string

documentType

errorHandlingType

  • Returns ErrorHandlingType

  • Parameters

    Returns void

fileVariableName

  • get fileVariableName(): string
  • set fileVariableName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

isLoaded

  • get isLoaded(): boolean

  • Checks whether all attributes are available ATM

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

    Returns boolean

languageSetting

languageVariableName

  • get languageVariableName(): string
  • set languageVariableName(newValue: string): void

  • Returns string

  • Parameters

    • newValue: string

    Returns void

marginBottomInInch

  • get marginBottomInInch(): string
  • set marginBottomInInch(newValue: string): void

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

    Returns string

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

    Parameters

    • newValue: string

    Returns void

marginLeftInInch

  • get marginLeftInInch(): string
  • set marginLeftInInch(newValue: string): void

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

    Returns string

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

    Parameters

    • newValue: string

    Returns void

marginRightInInch

  • get marginRightInInch(): string
  • set marginRightInInch(newValue: string): void

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

    Returns string

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

    Parameters

    • newValue: string

    Returns void

marginTopInInch

  • get marginTopInInch(): string
  • set marginTopInInch(newValue: string): void

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

    Returns string

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

    Parameters

    • newValue: string

    Returns void

model

  • get model(): TModel

  • Returns TModel

overrideBottomMargin

  • get overrideBottomMargin(): boolean
  • set overrideBottomMargin(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

overrideLeftMargin

  • get overrideLeftMargin(): boolean
  • set overrideLeftMargin(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

overrideRightMargin

  • get overrideRightMargin(): boolean
  • set overrideRightMargin(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

overrideTopMargin

  • get overrideTopMargin(): boolean
  • set overrideTopMargin(newValue: boolean): void

  • Returns boolean

  • Parameters

    • newValue: boolean

    Returns void

parameterMappings

unit

Methods

allProperties

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.

    Returns GenerateDocumentAction

deepCopy

deepCopyWithIdMap

delete

  • delete(): void

detach

findElementById

Protected getContainerAs

  • getContainerAs<T>(containerType: any): T

load

  • 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

    Returns void

  • Parameters

    • Optional forceRefresh: boolean

    Returns Promise<GenerateDocumentAction>

loadedProperties

publicProperties

toJSON

  • toJSON(): IStructureJSON

  • Renders the structure as plain JSON (without observables magic). This is intended for debugging and development convenience. Note that the resulting object is not of the interface type corresponding to this structure.

    Returns IStructureJSON

traverse

  • traverse(visit: (structure: IStructure) => void): void

  • Traverses this structure by calling the provided visitor function on itself and all the structures contained (as part) by it, in depth-first order, and it returns synchronously after that.

    Parameters

    Returns void

traverseFind

  • traverseFind<T>(visit: (structure: IStructure) => T): null | T

traversePublicParts

  • traversePublicParts(visit: (structure: IStructure) => void): 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

    • model: IModel

    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