Skip to main content

Document Properties

An object defining properties for the Document class.

ShowEvents

Determines if events related to the document are displayed to the user.

Type: bool


UseTimeStamp

Indicates whether a timestamp should be included with the document's signature.

Type: bool


DocumentObjectKey

A unique key that identifies the document object within the system.

Type: string


ViewName

The name of the view associated with this document, defining its display layout.

Type: string


AllowEdit

Indicates whether the document can be edited by the user.

Type: bool


SignatureFormat

Defines the format of the document's signature, such as visual or digital signature types.

Type: int


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

ViewId

An identifier for the view that controls the document's display format.

Type: string


CAdESSignatureType

Specifies the type of CAdES signature used for the document, allowing for advanced electronic signature standards.

Type: int


SignatureOption

Specifies the signature option for the document, controlling whether and how the document should be signed.

Type: int


DocumentObjectName

The name of the document object as displayed in the user interface.

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