Skip to main content

IFlowDocumentOptions Properties

An object defining properties for the IFlowDocumentOptions class.

FormCaption

The caption of the form associated with the document.

Type: string


ViewId

The ID of the view associated with the document.

Type: string


GeneralIsChanged

Indicates if any general properties within this document options instance have been modified.

Type: bool


DocumentId

The unique ID of the document within the workflow system.

Type: long


FormName

The name of the form associated with the document.

Type: string


ProcessName

The name of the project associated with the document.

Type: string


IsChanged

Indicates whether any changes have been made to the workflow object in the code, showing if it has unsaved modifications.

Type: bool


Type

Specifies the type of document operation within the workflow.

Type: CreateDocumentType
Accepted Values:

NameValue
None0
CreateForm1
AddExisting2

ViewName

The name of the view associated with the document.

Type: string


ExistingDocumentPath

The path of an existing document if it is referenced within the workflow.

Type: string


FormReadOnly

Indicates if the form should be read-only within the document.

Type: bool


Parameters

Additional parameters for configuring the document in the workflow.

Type: Dictionary<string, object>


PanelSize

The PanelSize enum defines the different size options for forms in the user interface, determining how much of the screen a panel occupies when displayed.

Type: PanelSize
Accepted Values:

NameValue
None0
Small1
Medium2
Large3

ProcessId

The ID of the project associated with the document.

Type: string


FormId

The ID of the form associated with the document.

Type: string