Skip to navigation
Apex Toolkit reference

TabGroup

View as Markdown
global class TabGroup extends Tab
Description
A Docusign envelope recipient tab group.

To assign a tab to a group, you assign the group's dataLabel to the tab's tabDataLabels array.

maximumTabs
global Integer maximumTabs
The maximum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.

Corresponds to the maximumAllowed API property.

minimumTabs
global Integer minimumTabs
The minimum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.

Corresponds to the minimumRequired API property.

rule
global String rule
Specifies how minimumTabs and maximumTabs are interpreted when selecting tabs in a group. Possible values are:
  • SelectAtLeast
  • SelectAtMost
  • SelectExactly
  • SelectARange

Corresponds to the groupRule API property.

scope
global String scope
The scope of the tab group. Possible values are:
  • document
  • envelope (default)

Corresponds to the tabScope API property.

Methods

global TabGroup()
Description
Constructs a tab group.
global TabGroup withMaximumTabs(final Integer maximumTabs)
Description
Updates the tab maximumTabs property.
Returns
The tab with an updated maximumTabs value.
Parameters
maximumTabs
final Integer maximumTabs
The maximum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.
global TabGroup withMinimumTabs(final Integer minimumTabs)
Description
Updates the tab minimumTabs property.
Returns
The tab with an updated minimumTabs value.
Parameters
minimumTabs
final Integer minimumTabs
The minimum number of tabs within the group that should be checked, populated, or signed. This property is used for validation.
global TabGroup withRule(final String rule)
Description
Updates the tab rule property.
Returns
The tab with an updated rule value.
Parameters
rule
final String rule
Specifies how minimumTabs and maximumTabs are interpreted when selecting tabs in a group.
global TabGroup withScope(final String scope)
Description
Updates the tab scope property.
Returns
The tab with an updated scope value.
Parameters
scope
final String scope
The scope of the tab group.