Skip to navigation
Apex Toolkit reference

DrawTab

View as Markdown
global class DrawTab extends Tab
Description
A tab allowing a recipient to draw in the space provided and optionally allow background image uploads.
allowBackgroundImageUpload
global Boolean allowBackgroundImageUpload
When true, signers may upload background images.

Corresponds to the allowSignerUpload API property.

collaboration
global Tab.Collaboration collaboration
Tab collaboration settings.
readOnly
global Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.

Corresponds to the locked API property.

required
global Boolean required
When set to true, the signer is required to fill out this tab.

Methods

global DrawTab()
Description
Constructs a draw tab.
global DrawTab withAllowBackgroundImageUpload(final Boolean allowBackgroundImageUpload)
Description
Updates the tab allowBackgroundImageUpload property.
Returns
The tab with an updated allowBackgroundImageUpload value.
Parameters
allowBackgroundImageUpload
final Boolean allowBackgroundImageUpload
When true, signers may upload background images.
global DrawTab withCollaboration(final Tab.Collaboration collaboration)
Description
Updates the tab collaboration property.
Returns
The tab with an updated collaboration value.
Parameters
collaboration
final Tab.Collaboration collaboration
Tab collaboration settings.
global DrawTab withReadOnly(final Boolean readOnly)
Description
Updates the tab readOnly property.
Returns
The tab with an updated readOnly value.
Parameters
readOnly
final Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.
global DrawTab withRequired(final Boolean required)
Description
Updates the tab required property.
Returns
The tab with an updated required value.
Parameters
required
final Boolean required
When set to true, the signer is required to fill out this tab.