Skip to main content

FormSecret Properties

An object defining properties for the FormSecret class.

ReadOnly

Indicates whether the document is read-only, restricting modifications.

Type: bool


InvisibleControls

Stores a serialized key-value string of components with Visible set to false, allowing their values to be restored during form initialization since they are not rendered on the UI.

Type: string


CanSaveAsDraft

Specifies whether the form document can be saved as a draft, if applicable.

Type: bool?


TokenId

The unique identifier associated with the secret token.

Type: string


DocumentId

Represents the unique identifier for the document associated with this form.

Type: long


OpenedBy

Indicates the user or system that opened the form, useful for tracking and access control.

Type: OpenedBy
Accepted Values:

NameValue
None0
Grid1

HasFormViewIgnored

Indicates whether certain form views are ignored for the document.

Type: bool


LockedControlsHash

Stores a hashed key-value representation of server-protected form fields to ensure data integrity. Upon client submission, a new hash is generated and compared to detect unauthorized changes to values of controls where the Enabled property is set to false or the control is marked as ReadOnly.

Type: string


View

Specifies the view type for the document, controlling how it is displayed to users.

Type: string


Parameters

A dictionary of additional parameters associated with the form, allowing for extended customization.

Type: Dictionary<string, object>


Validate

Determines whether the document should be validated before actions are performed.

Type: bool


RandomValue

A randomly generated value, created when the secret is initialized.

Type: string