Skip to navigation
Apex Toolkit reference

RadioGroupTab

View as Markdown
global class RadioGroupTab extends Tab
Description
A radio group tab places a group of radio buttons on a document. The radios property is used to add and place the radio buttons associated with the group. Only one radio button can be selected in a group. This value can be set.
collaboration
global Tab.Collaboration collaboration
Tab collaboration settings.
radios
global List<Radio> radios
Specifies the locations and status for radio buttons that are grouped together.

Methods

global RadioGroupTab()
Description
Constructs a radio group tab.
global RadioGroupTab 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 RadioGroupTab withRadios(final List<Radio> radios)
Description
Updates the tab radios property.
Returns
The tab with an updated radios value.
Parameters
radios
final List<Radio> radios
Specifies the locations and status for radio buttons that are grouped together.

RadioGroupTab.Position

global class Position
Description
Where to render the radio button on the document.
pageNumber
global Integer pageNumber
Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
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.

Corresponds to the xPosition API parameter.

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.

Corresponds to the yPosition API parameter.

Methods

global Position(final Integer pageNumber, final Integer x, final Integer y)
Description
Constructs a radio button position.
Parameters
pageNumber
final Integer pageNumber
Specifies the page number on which the tab is located. Must be 1 for supplemental documents.
x
final Integer x
This property indicates the horizontal offset of the object on the page.
y
final Integer y
This property indicates the vertical offset of the object on the page.

RadioGroupTab.Radio

global class Radio
Description
A radio button.
anchor
global Tab.Anchor anchor
Tab auto-place settings.
formatting
global Tab.Formatting formatting
Tab formatting settings.
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 tabOrder value, the normal auto-navigation setting behavior for the envelope is used.

Corresponds to the tabOrder property.

position
global Position position
Tab position on the document.
readOnly
global Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.

Corresponds to the locked API parameter.

required
global Boolean required
When set to true, the signer is required to fill out this tab.
selected
global Boolean selected
When set to true, the radio button is selected.
value
global Object value
Specifies the value of the tab.

Methods

global Radio( final Integer order, final Position position, final Tab.Formatting formatting, final Tab.Anchor anchor, final Object value, final Boolean selected, final Boolean readOnly, final Boolean required )
Description
Constructs a radio button.
Parameters
order
final Integer order
A positive integer that sets the order the tab is navigated to during signing.
position
final Position position
Tab position on the document.
formatting
final Tab.Formatting formatting
Tab formatting settings.
anchor
final Tab.Anchor anchor
Tab auto-place settings.
value
final Object value
Specifies the value of the tab.
selected
final Boolean selected
When set to true, the radio button is selected.
readOnly
final Boolean readOnly
When set to true, the signer cannot change the data of the custom tab.
required
final Boolean required
When set to true, the signer is required to fill out this tab.