Skip to navigation
Apex Toolkit reference

SmartSectionTab

View as Markdown
global class SmartSectionTab extends Tab
Description
Smart Section tabs enhance responsive signing on mobile devices by enabling collapsible sections, page breaks, custom formatting options, and other advanced functionality.

Note: Smart Sections are a premium feature. Responsive signing must also be enabled for your account.

display
global Display display
How the HTML section inside the smartAnchor displays.

Corresponds to the displaySettings API parameter.

smartAnchors
global Anchors smartAnchors
Specifies the area in the HTML where the display settings will be applied.

Methods

global SmartSectionTab()
Description
Constructs a Smart Section tab.
global SmartSectionTab withDisplay(final Display display)
Description
Updates the tab display property.
Returns
The tab with an updated display value.
Parameters
display
final Display display
How the HTML section inside the smartAnchor displays.
global SmartSectionTab withSmartAnchors(final Anchors smartAnchors)
Description
Updates the tab smartAnchors property.
Returns
The tab with an updated smartAnchors value.
Parameters
smartAnchors
final Anchors smartAnchors
Specifies the area in the HTML where the display settings will be applied.

SmartSectionTab.Position

global class Position
Description
Where to render the Smart Section 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 Smart Section position.
Parameters
pageNumber
final Integer pageNumber
Specifies the page number on which the tab is located.
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.

SmartSectionTab.Anchor

global class Anchor
Description
Smart Section tab auto-place settings.
position
global Position position
Where to render the Smart Section on the document.
remove
global Boolean remove
When true, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.

Corresponds to the removeStartAnchor or removeEndAnchor API property.

text
global String text
Specifies the area in the HTML where the display settings will be applied.

Corresponds to the startAnchor or endAnchor API property.

Methods

global Anchor(final Position position, final String text, final Boolean remove)
Description
Constructs a Smart Section anchor.
Parameters
position
final Position position
Where to render the Smart Section on the document.
text
final String text
Specifies the area in the HTML where the display settings will be applied.
remove
final Boolean remove
When true, removes the start anchor string for the Smart Section from the HTML, preventing it from displaying.

SmartSectionTab.Anchors

global class Anchors
Description
Smart Section tab anchors.
caseSensitive
global Boolean caseSensitive
When true, the startAnchor and endAnchor for the Smart Section must match both the case and the content of the strings in the HTML.
endAnchor
global Anchor endAnchor
Specifies the end of the area in the HTML where the display settings will be applied. If you do not specify an end anchor, the end of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

startAnchor
global Anchor startAnchor
Specifies the beginning of the area in the HTML where the display settings will be applied. If you do not specify a start anchor, the beginning of the document will be used by default.

Note: A start anchor, an end anchor, or both are required.

Methods

global Anchors(final Anchor startAnchor, final Anchor endAnchor, final Boolean caseSensitive)
Description
Constructs Smart Section anchors.
Parameters
startAnchor
final Anchor startAnchor
Specifies the beginning of the area in the HTML where the display settings will be applied.
endAnchor
final Anchor endAnchor
Specifies the end of the area in the HTML where the display settings will be applied.
caseSensitive
final Boolean caseSensitive
When true, the startAnchor and endAnchor for the Smart Section must match both the case and the content of the strings in the HTML.

SmartSectionTab.Collapsible

global class Collapsible
Description
Defines the appearance and function of a collapsible section or item.
arrowClosed
global String arrowClosed
Closed arrow.
arrowColor
global String arrowColor
Arrow color.
arrowLocation
global String arrowLocation
Arrow location.
arrowOpen
global String arrowOpen
Open arrow.
arrowSize
global String arrowSize
Arrow size.
arrowStyle
global String arrowStyle
Arrow style.
containerStyle
global String containerStyle
Container style.
labelStyle
global String labelStyle
Label style.
onlyArrowIsClickable
global Boolean onlyArrowIsClickable
When true, only the arrow is clickable.
outerLabelAndArrowStyle
global String outerLabelAndArrowStyle
Outer label and arrow style.

Methods

global Collapsible( final String containerStyle, final String labelStyle, final String outerLabelAndArrowStyle, final String arrowStyle, final String arrowClosed, final String arrowOpen, final String arrowLocation, final String arrowColor, final String arrowSize, final Boolean onlyArrowIsClickable )
Description
Constructs collapsible display settings.
Parameters
containerStyle
final String containerStyle
Container style.
labelStyle
final String labelStyle
Label style.
outerLabelAndArrowStyle
final String outerLabelAndArrowStyle
Outer label and arrow style.
arrowStyle
final String arrowStyle
Arrow style.
arrowClosed
final String arrowClosed
Closed arrow.
arrowOpen
final String arrowOpen
Open arrow.
arrowLocation
final String arrowLocation
Arrow location.
arrowColor
final String arrowColor
Arrow color.
arrowSize
final String arrowSize
Arrow size.
onlyArrowIsClickable
final Boolean onlyArrowIsClickable
When true, only the arrow is clickable.

SmartSectionTab.Display

global class Display
Description
Defines how the HTML section inside the startAnchor and endAnchor displays.
cellStyle
global String cellStyle
Specifies the valid CSS-formatted styles to use on responsive table cells. Only valid in display sections of responsive_table or responsive_table_single_column types.
collapsible
global Collapsible collapsible
The appearance and function of a collapsible section or item.
display
global String display
Indicates the display type. Must be one of the following enum values:
  • inline: Leaves the HTML where it is in the document. This allows for adding a label or presenting on a separate page.
  • collapsible: The HTML in the section may be expanded or collapsed. By default, the section is expanded.
  • collapsed: The HTML in the section may be expanded or collapsed. By default, the section is collapsed.
  • responsive_table: Converts the section into a responsive table. Note that this style is applied only on HTML tables that fall within the startAnchor and endAnchor positions.
  • responsive_table_single_column: Converts the section into a responsive, single-column table. Note that this style is applied only on HTML tables that fall within the startAnchor and endAnchor positions. The table is converted to a single column in which each column becomes a row and is stacked.
  • print_only: Prevents this portion of the HTML from displaying in the responsive signing view.
hideLabelWhenOpened
global Boolean hideLabelWhenOpened
When true, the label is hidden when the display section is expanded and the display section is no longer collapsible. This property is valid only when the value of the display property is collapsed.
inlineOuterStyle
global String inlineOuterStyle
Specifies the valid CSS-formatted styles to use on inline display sections. This property is valid only when the value of the display property is inline.
label
global String label
The label for the display section.

Corresponds to the displayLabel API property.

labelWhenOpened
global String labelWhenOpened
The label for the display section when it is expanded from a collapsed state. This label displays only on the first opening and is only valid with the value of the display property is collapsed.
order
global Integer order
The position on the page where the display section appears.

Corresponds to the displayOrder API property.

pageNumber
global Integer pageNumber
The number of the page on which the display section appears.

Corresponds to the displayPageNumber API property.

preLabel
global String preLabel
Descriptive text that appears before a collapsed section or continue button.
scrollToTopWhenOpened
global Boolean scrollToTopWhenOpened
When true and the section is expanded, the position of the section close is scrolled to the top of the screen. This property is only valid when the value of the display property is collapsed.
tableStyle
global String tableStyle
Specifies the valid CSS-formatted styles to use on responsive tables. This property is valid only when the value of the display property is responsive_table or responsive_table_single_column.

Methods

global Display( final String label, final String display, final Integer pageNumber, final Integer order, final String tableStyle, final String cellStyle, final String inlineOuterStyle, final Boolean hideLabelWhenOpened, final Boolean scrollToTopWhenOpened, final String labelWhenOpened, final String preLabel, final Collapsible collapsible )
Description
Constructs Smart Section display settings.
Parameters
label
final String label
The label for the display section.
display
final String display
Indicates the display type.
pageNumber
final Integer pageNumber
The number of the page on which the display section appears.
order
final Integer order
The position on the page where the display section appears.
tableStyle
final String tableStyle
Specifies the valid CSS-formatted styles to use on responsive tables.
cellStyle
final String cellStyle
Specifies the valid CSS-formatted styles to use on responsive table cells.
inlineOuterStyle
final String inlineOuterStyle
Specifies the valid CSS-formatted styles to use on inline display sections.
hideLabelWhenOpened
final Boolean hideLabelWhenOpened
When true, the label is hidden when the display section is expanded and the display section is no longer collapsible.
scrollToTopWhenOpened
final Boolean scrollToTopWhenOpened
When true and the section is expanded, the position of the section close is scrolled to the top of the screen.
labelWhenOpened
final String labelWhenOpened
The label for the display section when it is expanded from a collapsed state.
preLabel
final String preLabel
Descriptive text that appears before a collapsed section or continue button.
collapsible
final Collapsible collapsible
The appearance and function of a collapsible section or item.