Skip to navigation
Apex Toolkit reference

Tab

View as Markdown
global abstract class Tab
Description
Base class for Docusign envelope recipient tabs. This may not be directly instantiated.

All of the property values are passed through as-is to the eSignature REST API. For more information regarding how to construct and use envelope recipient tabs, refer to Envelope Recipient Tabs on the Docusign Developer Center.

anchor
@AuraEnabled global Anchor anchor
Tab auto-place settings.
ComponentType
global enum ComponentType
Tab merge field path component types.
condition
global Condition condition
Conditional tab settings.
customTabId
@AuraEnabled global UUID customTabId
The Docusign-generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties.
dataLabel
@AuraEnabled global String dataLabel
The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.

Corresponds with the tabLabel API property.

groupDataLabels
global List<String> groupDataLabels
An array of tab group data labels that uniquely identify tab groups. To assign a tab to a group, you assign the group's dataLabel to this array.

Corresponds to the tabGroupLabels API property.

guidedForm
global GuidedForm guidedForm
Tab guided form settings.
id
global UUID id
The unique identifier for the tab.

Corresponds with the tabId API property.

name
global String name
The name of the tab.
order
global Integer order
A positive integer that sets the order the tab is navigated to during signing.

Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same order value, the normal auto-navigation setting behavior for the envelope is used.

Corresponds to the tabOrder API property.

position
@AuraEnabled global Position position
Tab position on the document.
smartContract
global SmartContract smartContract
Tab smart contract settings.
tabType
global Type tabType
The type of the tab. This property is read-only.
tooltip
@AuraEnabled global String tooltip
The text of a tooltip that appears when a user hovers over a form field or tab.
Type
global enum Type
Docusign envelope recipient tab types.

Methods

global Tab withAnchor(final Anchor anchor)
Description
Updates the tab anchor property.
Returns
The tab with an updated anchor value.
Parameters
anchor
final Anchor anchor
Tab auto-place settings.
global Tab withCondition(final Condition condition)
Description
Updates the tab condition property.
Returns
The tab with an updated condition value.
Parameters
condition
final Condition condition
Conditional tab settings.
global Tab withCustomTabId(final UUID customTabId)
Description
Updates the tab customTabId property.
Returns
The tab with an updated customTabId value.
Parameters
customTabId
final UUID customTabId
The Docusign-generated custom tab ID for the custom tab to be applied.
global Tab withDataLabel(final String dataLabel)
Description
Updates the tab dataLabel property.
Returns
The tab with an updated dataLabel value.
Parameters
dataLabel
final String dataLabel
The label associated with the tab.
global Tab withGroupDataLabels(final List<String> groupDataLabels)
Description
Updates the tab groupDataLabels property.
Returns
The tab with an updated groupDataLabels value.
Parameters
groupDataLabels
final List<String> groupDataLabels
An array of tab group data labels that uniquely identify tab groups.
global Tab withGuidedForm(final GuidedForm guidedForm)
Description
Updates the tab guidedForm property.
Returns
The tab with an updated guidedForm value.
Parameters
guidedForm
final GuidedForm guidedForm
Tab guided form settings.
global Tab withId(final UUID id)
Description
Updates the tab id property.
Returns
The tab with an updated id value.
Parameters
id
final UUID id
The unique identifier for the tab.
global Tab withName(final String name)
Description
Updates the tab name property.
Returns
The tab with an updated name value.
Parameters
name
final String name
The name of the tab.
global Tab withOrder(final Integer order)
Description
Updates the tab order property.
Returns
The tab with an updated order value.
Parameters
order
final Integer order
A positive integer that sets the order the tab is navigated to during signing.
global Tab withPosition(final Position position)
Description
Updates the tab position property.
Returns
The tab with an updated position value.
Parameters
position
final Position position
Tab position on the document.
global Tab withSmartContract(final SmartContract smartContract)
Description
Updates the tab smartContract property.
Returns
The tab with an updated smartContract value.
Parameters
smartContract
final SmartContract smartContract
Tab smart contract settings.
global Tab withTooltip(final String tooltip)
Description
Updates the tab tooltip property.
Returns
The tab with an updated tooltip value.
Parameters
tooltip
final String tooltip
The text of a tooltip that appears when a user hovers over a form field or tab.

Tab.Position

global class Position
Description
Where to apply the tab and the dimensions of the tab.
documentSequence
global Integer documentSequence
On which document to apply the tab.

Corresponds to the documentId API property.

height
@AuraEnabled global Integer height
The height of the tab in pixels.
pageNumber
global Integer pageNumber
Specifies the page number on which the tab is located. For supplemental documents, this value must be 1.
width
@AuraEnabled global Integer width
The width of the tab in pixels.
x
global Integer x
This property indicates the horizontal offset of the object on the page. Docusign uses 72 DPI when determining position. Required. May be zero.

To improve the tab's position on the document, Docusign recommends adjusting the X and Y position coordinates by (-3, -2).

Corresponds to the xPosition API property.

y
global Integer y
This property indicates the vertical offset of the object on the page. Docusign uses 72 DPI when determining position. Required. May be zero.

To improve the tab's position on the document, Docusign recommends adjusting the X and Y position coordinates by (-3, -2).

Methods

global Position( final Integer documentSequence, final Integer pageNumber, final Integer x, final Integer y, final Integer width, final Integer height )
Description
Constructs tab positioning.
Parameters
documentSequence
final Integer documentSequence
On which document to apply the tab.
pageNumber
final Integer pageNumber
Specifies the page number on which the tab is located. For supplemental documents, this value must be 1.
x
final Integer x
Horizontal offset of the tab on the page.
y
final Integer y
Vertical offset of the tab on the page.
width
final Integer width
The width of the tab in pixels.
height
final Integer height
The height of the tab in pixels.

Tab.Anchor

global class Anchor
Description
Tab auto-place settings.
allowWhiteSpace
global Boolean allowWhiteSpace
Whether to allow white space in anchor strings.

Corresponds to the anchorAllowWhiteSpaceInCharacters API property.

caseSensitive
global Boolean caseSensitive
This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the text property for an anchor tab to be created. The default value is false.

Corresponds to to the anchorCaseSensitive API property.

horizontalAlignment
global String horizontalAlignment
This property controls how anchor tabs are aligned in relation to the anchor text. Possible values are:
  • left: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value.
  • right: Aligns the tabs left side with the last character of the matching anchor word.

Corresponds to to the anchorHorizontalAlignment API property.

ignoreIfNotPresent
global Boolean ignoreIfNotPresent
When set to true, this tab is ignored if the text is not found in the document.

Corresponds to to the anchorIgnoreIfNotPresent API property.

matchWholeWord
global Boolean matchWholeWord
When set to true, the text string in a document must match the value of the text property in its entirety for an anchor tab to be created. The default value is false.

Corresponds to the anchorMatchWholeWord API property.

text
@AuraEnabled global String text
The string to find in the document and use as the basis for tab placement.

Corresponds to the anchorString API property.

units
global String units
Specifies units of the xOffset and yOffset properties. Valid units are:
  • pixels
  • inches
  • mms
  • cms

Corresponds to the anchorUnits API property.

xOffset
global Integer xOffset
Specifies the X axis location of the tab in units relative to the text.
yOffset
global Integer yOffset
Specifies the Y axis location of the tab in units relative to the text.

Methods

global Anchor(final String text)
Description
Simple constructor for auto-place settings. Everything besides the anchor text will be defaulted.
Parameters
text
final String text
The string to find in the document and use as the basis for tab placement.
global Anchor( final String text, final Boolean allowWhiteSpace, final Boolean caseSensitive, final String horizontalAlignment, final Boolean ignoreIfNotPresent, final Boolean matchWholeWord, final String units, final Integer xOffset, final Integer yOffset )
Description
Full constructor for auto-place settings.
Parameters
text
final String text
The string to find in the document and use as the basis for tab placement.
allowWhiteSpace
final Boolean allowWhiteSpace
Whether to allow white space in anchor strings.
caseSensitive
final Boolean caseSensitive
This property controls how anchor tabs are placed. When true, the text string in a document must match the case of the text property for an anchor tab to be created.
horizontalAlignment
final String horizontalAlignment
This property controls how anchor tabs are aligned in relation to the anchor text.
ignoreIfNotPresent
final Boolean ignoreIfNotPresent
When set to true, this tab is ignored if the text is not found in the document.
matchWholeWord
final Boolean matchWholeWord
When set to true, the text string in a document must match the value of the text property in its entirety for an anchor tab to be created.
units
final String units
Specifies units of the xOffset and yOffset properties
xOffset
final Integer xOffset
Specifies the X axis location of the tab in units relative to the text.
yOffset
final Integer yOffset
Specifies the Y axis location of the tab in units relative to the text.

Tab.GuidedForm

global class GuidedForm
Description
Tab guided form settings.
order
global Integer order
The order in which the guided form HTML should render. The order is relative to the pageLabel, the group by which to place the guided form HTML block.

Corresponds to the formOrder API parameter.

pageLabel
global String pageLabel
The group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.

Corresponds to the formPageLabel API parameter.

pageNumber
global Integer pageNumber
The order in which to present the guided form pages.

Corresponds to the formPageNumber API parameter.

Methods

global GuidedForm(final Integer order, final String pageLabel, final Integer pageNumber)
Description
Constructs tab guided form settings.
Parameters
order
final Integer order
The order in which the guided form HTML should render. The order is relative to the pageLabel, the group by which to place the guided form HTML block.
pageLabel
final String pageLabel
The group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience.
pageNumber
final Integer pageNumber
The order in which to present the guided form pages.

Tab.Condition

global class Condition
Description
Conditional tab settings.
parentDataLabel
global String parentDataLabel
For conditional fields this is the dataLabel of the parent tab that controls this tab's visibility.

Corresponds to the conditionalParentLabel API parameter.

parentValue
global String parentValue
For conditional fields, this is the value of the parent tab that controls the tab's visibility.

If the parent tab is a checkbox, radio button, optional sign here, or optional initial here use "on" as the value to show that the parent tab is active.

Corresponds to the conditionalParentValue API parameter.

Methods

global Condition(final String parentDataLabel, final String parentValue)
Description
Constructs conditional tab settings.
Parameters
parentDataLabel
final String parentDataLabel
For conditional fields this is the dataLabel of the parent tab that controls this tab's visibility.
parentValue
final String parentValue
For conditional fields, this is the value of the parent tab that controls the tab's visibility.

Tab.Formatting

global class Formatting
Description
Tab formatting settings.
bold
@AuraEnabled global Boolean bold
When set to true, the information in the tab is bold.
color
@AuraEnabled global String color
The font color to use for the information in the tab. Possible values are:
  • Black
  • BrightBlue
  • BrightRed
  • DarkGreen
  • DarkRed
  • Gold
  • Green
  • NavyBlue
  • Purple
  • White

    • Corresponds to the fontColor API parameter.

concealValue
@AuraEnabled global Boolean concealValue
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.

When an envelope is completed the information is only available to the sender through the Form Data link in the Docusign Console. The information on the downloaded document remains masked by asterisks.

This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

Corresponds to the concealValueOnDocument API parameter.

fixedWidth
@AuraEnabled global Boolean fixedWidth
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

Corresponds to the fixedWidth API parameter.

font
@AuraEnabled global String font
The font to be used for the tab value. Supported fonts include:
  • Default
  • Arial
  • ArialNarrow
  • Calibri
  • CourierNew
  • Garamond
  • Georgia
  • Helvetica
  • LucidaConsole
  • MSGothic
  • MSMincho
  • OCR-A
  • Tahoma
  • TimesNewRoman
  • Trebuchet
  • Verdana
italic
@AuraEnabled global Boolean italic
When set to true, the information in the tab is italicized.
size
@AuraEnabled global Integer size
The font size in points used for the information in the tab. Possible values are: 7, 8, 9, 10, 11, 12, 14, 16, 18, 20, 22, 24, 26, 28, 36, 48 and 72..

Corresponds to the fontSize API parameter.

underline
@AuraEnabled global Boolean underline
When set to true, the information in the tab is underlined.

Methods

global Formatting( final String font, final String color, final Integer size, final Boolean bold, final Boolean italic, final Boolean underline, final Boolean concealValue, final Boolean fixedWidth )
Description
Constructs tab formatting settings.
Parameters
font
final String font
The font to be used for the tab value.
color
final String color
The font color to use for the information in the tab.
size
final Integer size
The font size in points used for the information in the tab.
bold
final Boolean bold
When set to true, the information in the tab is bold.
italic
final Boolean italic
When set to true, the information in the tab is italicized.
underline
final Boolean underline
When set to true, the information in the tab is underlined.
concealValue
final Boolean concealValue
When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.
fixedWidth
final Boolean fixedWidth
When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

Tab.Validation

global class Validation
Description
Tab validation settings.
errorMessage
@AuraEnabled global String errorMessage
The message displayed if the custom tab fails input validation.

Corresponds to the validationMessage API property.

maximumLength
@AuraEnabled global Integer maximumLength
An optional value that describes the maximum length of the property when the property is a string.

Corresponds to the maxLength API property.

pattern
@AuraEnabled global String pattern
A regular expression used to validate input for the tab.

Corresponds to the validationPattern API property.

Methods

global Validation(final Integer maximumLength, final String pattern, final String errorMessage)
Description
Constructs tab validation settings.
Parameters
maximumLength
final Integer maximumLength
An optional value that describes the maximum length of the property when the property is a string.
pattern
final String pattern
A regular expression used to validate input for the tab.
errorMessage
final String errorMessage
The message displayed if the custom tab fails input validation.

Tab.PathComponent

global class PathComponent
Description
Tab merge field path component.
name
@AuraEnabled global String name
The Salesforce API name of the object or field.
salesforceType
@AuraEnabled global String salesforceType
The Salesforce data type.
type
global ComponentType type
The path component type.

Methods

global PathComponent(final String name, final ComponentType type, final String salesforceType)
Description
Constructs a tab merge field path component.
Parameters
name
final String name
The Salesforce API name of the object or field.
type
final ComponentType type
The path component type.
salesforceType
final String salesforceType
The Salesforce data type.

Tab.MergeField

global class MergeField
Description
Contains the information necessary to map the tab to a field in SalesForce.
path
@AuraEnabled global String path
The path to the Salesforce merge field. Used when Docusign Connect for Salesforce is configured on the account.
pathExtended
@AuraEnabled global List<PathComponent> pathExtended
The extended path to the Salesforce merge field. Used when Docusign Connect for Salesforce is not configured on the account.
row
global Integer row
Specifies the row number in a Salesforce table that the merge field value corresponds to.
senderReadOnly
@AuraEnabled global Boolean senderReadOnly
When true, the sender cannot modify the value of the mergeField tab during the sending process.

Corresponds to the allowSenderToEdit API property.

writeBack
@AuraEnabled global Boolean writeBack
When true, data entered into the merge field during Signing will update the mapped Salesforce field.

Methods

global MergeField( final String path, final List<PathComponent> pathExtended, final Integer row, final Boolean writeBack, final Boolean senderReadOnly )
Description
Constructs a Salesforce merge field.
Parameters
path
final String path
The path to the Salesforce merge field.
pathExtended
final List<PathComponent> pathExtended
The extended path to the Salesforce merge field.
row
final Integer row
Specifies the row number in a Salesforce table that the merge field value corresponds to.
writeBack
final Boolean writeBack
When true, data entered into the merge field during Signing will update the mapped Salesforce field.
senderReadOnly
final Boolean senderReadOnly
When true, the sender cannot modify the value of the mergeField tab during the sending process.

Tab.Collaboration

global class Collaboration
Description
Tab collaboration settings.
canCollaborate
@AuraEnabled global Boolean canCollaborate
When set to true, this custom tab is collaborative.

Corresponds to the shared API property.

required
@AuraEnabled global Boolean required
When set to true and canCollaborate is true, information must be entered in this field to complete the envelope.

Corresponds to the requireAll API property.

requireInitialOnChange
global Boolean requireInitialOnChange
Optional element for field markup. When set to true, the signer is required to initial when they modify a collaborative field.

Corresponds to the requireInitialOnSharedChange API property.

Methods

global Collaboration(final Boolean canCollaborate, final Boolean required, final Boolean requireInitialOnChange)
Description
Constructs tab collaboration settings.
Parameters
canCollaborate
final Boolean canCollaborate
When set to true, this custom tab is collaborative.
required
final Boolean required
When set to true and canCollaborate is true, information must be entered in this field to complete the envelope.
requireInitialOnChange
final Boolean requireInitialOnChange
Optional element for field markup. When set to true, the signer is required to initial when they modify a collaborative field.

Tab.SmartContract

global class SmartContract
Description
Tab smart contract settings.
code
global String code
The smart contract code.
uri
global String uri
A URI containing the user ID.

Methods

global SmartContract(final String code, final String uri)
Description
Constructs tab smart contract settings.
Parameters
code
final String code
The smart contract code.
uri
final String uri
A URI containing the user ID.