Skip to navigation

FormulaTab

View as Markdown
global virtual class FormulaTab extends ReadWriteTab
Description
A Docusign envelope recipient formula tab.

The value of a formula tab is calculated from the values of other number or date tabs in the document. When the recipient completes the underlying fields, the formula tab calculates and displays the result. This value can be set.

The formula property of the tab contains the references to the underlying tabs. To learn more about formulas, see Calculated Fields.

formula
global String formula
Contains the formula for calculating the value of this tab. Use a tab's dataLabel, enclosed in brackets, to refer to it.

For example, you want to present the total cost of two items, tax included. The cost of each item is stored in number tabs labeled Item1 and Item2. The tax rate is in a number tab labeled TaxRate. The formula string for this property would be: ([Item1] + [Item2]) * (1 + [TaxRate])

See Calculated Fields in the Docusign Support Center to learn more about formulas.

hidden
global Boolean hidden
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 checkboxes.

roundDecimalPlaces
global Integer roundDecimalPlaces
The number of decimal places to round to.

Methods

global FormulaTab()
Description
Constructs a Formula Tab
global FormulaTab withFormula(final String formula)
Description
Updates the tab formula property.
Returns
The tab with an updated formula value.
Parameters
formula
final String formula
Contains the formula for calculating the value of this tab.
global FormulaTab withHidden(final Boolean hidden)
Description
Updates the tab hidden property.
Returns
The tab with an updated hidden value.
Parameters
hidden
final Boolean hidden
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.
global FormulaTab withRoundDecimalPlaces(final Integer roundDecimalPlaces)
Description
Updates the tab roundDecimalPlaces property.
Returns
The tab with an updated roundDecimalPlaces value.
Parameters
roundDecimalPlaces
final Integer roundDecimalPlaces
The number of decimal places to round to.