Skip to main content

FormSecret

The FormSecret class contains security and access parameters for form documents, allowing for customized document behavior based on the specified properties, such as read-only status, validation, and view options.

Properties

NameDescription
HasFormViewIgnoredIndicates whether certain form views are ignored for the document.
ValidateDetermines whether the document should be validated before actions are performed.
ReadOnlyIndicates whether the document is read-only, restricting modifications.
DocumentIdRepresents the unique identifier for the document associated with this form.
CanSaveAsDraftSpecifies whether the form document can be saved as a draft, if applicable.
InvisibleControlsStores 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.
OpenedByIndicates the user or system that opened the form, useful for tracking and access control.
LockedControlsHashStores 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.
RandomValueA randomly generated value, created when the secret is initialized.
ParametersA dictionary of additional parameters associated with the form, allowing for extended customization.
ViewSpecifies the view type for the document, controlling how it is displayed to users.
TokenIdThe unique identifier associated with the secret token.

Constructors

NameDescription
FormSecret(documentId, readOnly, view, validate, parameters, lockedControlsHash, invisibleControls, canSaveAsDraft, openedBy, hasFormViewIgnored)Initializes a new instance of the FormSecret class with the specified parameters.