Class FormulaTab

  • All Implemented Interfaces:
    Serializable

    public class FormulaTab
    extends Object
    implements Serializable
    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. The `formula` property of the tab contains the references to the underlying tabs. See [Calculated Fields][calculatedfields] in the DocuSign Support Center to learn more about formulas. If a formula tab contains a `paymentDetails` property, the tab is considered a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [calculatedfields]: https://support.docusign.com/en/guides/ndse-user-guide-calculated-fields [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures .
    See Also:
    Serialized Form
    • Constructor Detail

      • FormulaTab

        public FormulaTab()
    • Method Detail

      • agreementAttribute

        public FormulaTab agreementAttribute​(String agreementAttribute)
        agreementAttribute.
        Returns:
        FormulaTab
      • getAgreementAttribute

        public String getAgreementAttribute()
        .
        Returns:
        agreementAttribute
      • setAgreementAttribute

        public void setAgreementAttribute​(String agreementAttribute)
        setAgreementAttribute.
      • agreementAttributeLocked

        public FormulaTab agreementAttributeLocked​(String agreementAttributeLocked)
        agreementAttributeLocked.
        Returns:
        FormulaTab
      • getAgreementAttributeLocked

        public String getAgreementAttributeLocked()
        .
        Returns:
        agreementAttributeLocked
      • setAgreementAttributeLocked

        public void setAgreementAttributeLocked​(String agreementAttributeLocked)
        setAgreementAttributeLocked.
      • anchorAllowWhiteSpaceInCharacters

        public FormulaTab anchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        anchorAllowWhiteSpaceInCharacters.
        Returns:
        FormulaTab
      • getAnchorAllowWhiteSpaceInCharacters

        public String getAnchorAllowWhiteSpaceInCharacters()
        .
        Returns:
        anchorAllowWhiteSpaceInCharacters
      • setAnchorAllowWhiteSpaceInCharacters

        public void setAnchorAllowWhiteSpaceInCharacters​(String anchorAllowWhiteSpaceInCharacters)
        setAnchorAllowWhiteSpaceInCharacters.
      • anchorAllowWhiteSpaceInCharactersMetadata

        public FormulaTab anchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        anchorAllowWhiteSpaceInCharactersMetadata.
        Returns:
        FormulaTab
      • getAnchorAllowWhiteSpaceInCharactersMetadata

        public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
        Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..
        Returns:
        anchorAllowWhiteSpaceInCharactersMetadata
      • setAnchorAllowWhiteSpaceInCharactersMetadata

        public void setAnchorAllowWhiteSpaceInCharactersMetadata​(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
        setAnchorAllowWhiteSpaceInCharactersMetadata.
      • anchorCaseSensitive

        public FormulaTab anchorCaseSensitive​(String anchorCaseSensitive)
        anchorCaseSensitive.
        Returns:
        FormulaTab
      • getAnchorCaseSensitive

        public String getAnchorCaseSensitive()
        When set to **true**, the anchor string does not consider case when matching strings in the document. The default value is **true**..
        Returns:
        anchorCaseSensitive
      • setAnchorCaseSensitive

        public void setAnchorCaseSensitive​(String anchorCaseSensitive)
        setAnchorCaseSensitive.
      • anchorCaseSensitiveMetadata

        public FormulaTab anchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        anchorCaseSensitiveMetadata.
        Returns:
        FormulaTab
      • getAnchorCaseSensitiveMetadata

        public PropertyMetadata getAnchorCaseSensitiveMetadata()
        Metadata that indicates whether the `anchorCaseSensitive` property is editable..
        Returns:
        anchorCaseSensitiveMetadata
      • setAnchorCaseSensitiveMetadata

        public void setAnchorCaseSensitiveMetadata​(PropertyMetadata anchorCaseSensitiveMetadata)
        setAnchorCaseSensitiveMetadata.
      • anchorHorizontalAlignment

        public FormulaTab anchorHorizontalAlignment​(String anchorHorizontalAlignment)
        anchorHorizontalAlignment.
        Returns:
        FormulaTab
      • getAnchorHorizontalAlignment

        public String getAnchorHorizontalAlignment()
        Specifies the alignment of anchor tabs with anchor strings. Possible values are **left** or **right**. The default value is **left**..
        Returns:
        anchorHorizontalAlignment
      • setAnchorHorizontalAlignment

        public void setAnchorHorizontalAlignment​(String anchorHorizontalAlignment)
        setAnchorHorizontalAlignment.
      • anchorHorizontalAlignmentMetadata

        public FormulaTab anchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        anchorHorizontalAlignmentMetadata.
        Returns:
        FormulaTab
      • getAnchorHorizontalAlignmentMetadata

        public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
        Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..
        Returns:
        anchorHorizontalAlignmentMetadata
      • setAnchorHorizontalAlignmentMetadata

        public void setAnchorHorizontalAlignmentMetadata​(PropertyMetadata anchorHorizontalAlignmentMetadata)
        setAnchorHorizontalAlignmentMetadata.
      • anchorIgnoreIfNotPresent

        public FormulaTab anchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        anchorIgnoreIfNotPresent.
        Returns:
        FormulaTab
      • getAnchorIgnoreIfNotPresent

        public String getAnchorIgnoreIfNotPresent()
        When set to **true**, this tab is ignored if anchorString is not found in the document..
        Returns:
        anchorIgnoreIfNotPresent
      • setAnchorIgnoreIfNotPresent

        public void setAnchorIgnoreIfNotPresent​(String anchorIgnoreIfNotPresent)
        setAnchorIgnoreIfNotPresent.
      • anchorIgnoreIfNotPresentMetadata

        public FormulaTab anchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        anchorIgnoreIfNotPresentMetadata.
        Returns:
        FormulaTab
      • getAnchorIgnoreIfNotPresentMetadata

        public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
        Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..
        Returns:
        anchorIgnoreIfNotPresentMetadata
      • setAnchorIgnoreIfNotPresentMetadata

        public void setAnchorIgnoreIfNotPresentMetadata​(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
        setAnchorIgnoreIfNotPresentMetadata.
      • anchorMatchWholeWord

        public FormulaTab anchorMatchWholeWord​(String anchorMatchWholeWord)
        anchorMatchWholeWord.
        Returns:
        FormulaTab
      • getAnchorMatchWholeWord

        public String getAnchorMatchWholeWord()
        When set to **true**, the anchor string in this tab matches whole words only (strings embedded in other strings are ignored.) The default value is **true**..
        Returns:
        anchorMatchWholeWord
      • setAnchorMatchWholeWord

        public void setAnchorMatchWholeWord​(String anchorMatchWholeWord)
        setAnchorMatchWholeWord.
      • anchorMatchWholeWordMetadata

        public FormulaTab anchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        anchorMatchWholeWordMetadata.
        Returns:
        FormulaTab
      • getAnchorMatchWholeWordMetadata

        public PropertyMetadata getAnchorMatchWholeWordMetadata()
        Metadata that indicates whether the `anchorMatchWholeWord` property is editable..
        Returns:
        anchorMatchWholeWordMetadata
      • setAnchorMatchWholeWordMetadata

        public void setAnchorMatchWholeWordMetadata​(PropertyMetadata anchorMatchWholeWordMetadata)
        setAnchorMatchWholeWordMetadata.
      • anchorString

        public FormulaTab anchorString​(String anchorString)
        anchorString.
        Returns:
        FormulaTab
      • getAnchorString

        public String getAnchorString()
        Anchor text information for a radio button..
        Returns:
        anchorString
      • setAnchorString

        public void setAnchorString​(String anchorString)
        setAnchorString.
      • anchorStringMetadata

        public FormulaTab anchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        anchorStringMetadata.
        Returns:
        FormulaTab
      • getAnchorStringMetadata

        public PropertyMetadata getAnchorStringMetadata()
        Metadata that indicates whether the `anchorString` property is editable..
        Returns:
        anchorStringMetadata
      • setAnchorStringMetadata

        public void setAnchorStringMetadata​(PropertyMetadata anchorStringMetadata)
        setAnchorStringMetadata.
      • anchorTabProcessorVersion

        public FormulaTab anchorTabProcessorVersion​(String anchorTabProcessorVersion)
        anchorTabProcessorVersion.
        Returns:
        FormulaTab
      • getAnchorTabProcessorVersion

        public String getAnchorTabProcessorVersion()
        .
        Returns:
        anchorTabProcessorVersion
      • setAnchorTabProcessorVersion

        public void setAnchorTabProcessorVersion​(String anchorTabProcessorVersion)
        setAnchorTabProcessorVersion.
      • anchorTabProcessorVersionMetadata

        public FormulaTab anchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        anchorTabProcessorVersionMetadata.
        Returns:
        FormulaTab
      • getAnchorTabProcessorVersionMetadata

        public PropertyMetadata getAnchorTabProcessorVersionMetadata()
        Reserved for DocuSign..
        Returns:
        anchorTabProcessorVersionMetadata
      • setAnchorTabProcessorVersionMetadata

        public void setAnchorTabProcessorVersionMetadata​(PropertyMetadata anchorTabProcessorVersionMetadata)
        setAnchorTabProcessorVersionMetadata.
      • anchorUnits

        public FormulaTab anchorUnits​(String anchorUnits)
        anchorUnits.
        Returns:
        FormulaTab
      • getAnchorUnits

        public String getAnchorUnits()
        Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
        Returns:
        anchorUnits
      • setAnchorUnits

        public void setAnchorUnits​(String anchorUnits)
        setAnchorUnits.
      • anchorUnitsMetadata

        public FormulaTab anchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        anchorUnitsMetadata.
        Returns:
        FormulaTab
      • getAnchorUnitsMetadata

        public PropertyMetadata getAnchorUnitsMetadata()
        Metadata that indicates whether the `anchorUnits` property is editable..
        Returns:
        anchorUnitsMetadata
      • setAnchorUnitsMetadata

        public void setAnchorUnitsMetadata​(PropertyMetadata anchorUnitsMetadata)
        setAnchorUnitsMetadata.
      • anchorXOffset

        public FormulaTab anchorXOffset​(String anchorXOffset)
        anchorXOffset.
        Returns:
        FormulaTab
      • getAnchorXOffset

        public String getAnchorXOffset()
        Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorXOffset
      • setAnchorXOffset

        public void setAnchorXOffset​(String anchorXOffset)
        setAnchorXOffset.
      • anchorXOffsetMetadata

        public FormulaTab anchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        anchorXOffsetMetadata.
        Returns:
        FormulaTab
      • getAnchorXOffsetMetadata

        public PropertyMetadata getAnchorXOffsetMetadata()
        Metadata that indicates whether the `anchorXOffset` property is editable..
        Returns:
        anchorXOffsetMetadata
      • setAnchorXOffsetMetadata

        public void setAnchorXOffsetMetadata​(PropertyMetadata anchorXOffsetMetadata)
        setAnchorXOffsetMetadata.
      • anchorYOffset

        public FormulaTab anchorYOffset​(String anchorYOffset)
        anchorYOffset.
        Returns:
        FormulaTab
      • getAnchorYOffset

        public String getAnchorYOffset()
        Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
        Returns:
        anchorYOffset
      • setAnchorYOffset

        public void setAnchorYOffset​(String anchorYOffset)
        setAnchorYOffset.
      • anchorYOffsetMetadata

        public FormulaTab anchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        anchorYOffsetMetadata.
        Returns:
        FormulaTab
      • getAnchorYOffsetMetadata

        public PropertyMetadata getAnchorYOffsetMetadata()
        Metadata that indicates whether the `anchorYOffset` property is editable..
        Returns:
        anchorYOffsetMetadata
      • setAnchorYOffsetMetadata

        public void setAnchorYOffsetMetadata​(PropertyMetadata anchorYOffsetMetadata)
        setAnchorYOffsetMetadata.
      • getBold

        public String getBold()
        When set to **true**, the information in the tab is bold..
        Returns:
        bold
      • setBold

        public void setBold​(String bold)
        setBold.
      • getBoldMetadata

        public PropertyMetadata getBoldMetadata()
        Metadata that indicates whether the `bold` property is editable..
        Returns:
        boldMetadata
      • setBoldMetadata

        public void setBoldMetadata​(PropertyMetadata boldMetadata)
        setBoldMetadata.
      • caption

        public FormulaTab caption​(String caption)
        caption.
        Returns:
        FormulaTab
      • getCaption

        public String getCaption()
        .
        Returns:
        caption
      • setCaption

        public void setCaption​(String caption)
        setCaption.
      • getCaptionMetadata

        public PropertyMetadata getCaptionMetadata()
        .
        Returns:
        captionMetadata
      • setCaptionMetadata

        public void setCaptionMetadata​(PropertyMetadata captionMetadata)
        setCaptionMetadata.
      • concealValueOnDocument

        public FormulaTab concealValueOnDocument​(String concealValueOnDocument)
        concealValueOnDocument.
        Returns:
        FormulaTab
      • getConcealValueOnDocument

        public String getConcealValueOnDocument()
        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 available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
        Returns:
        concealValueOnDocument
      • setConcealValueOnDocument

        public void setConcealValueOnDocument​(String concealValueOnDocument)
        setConcealValueOnDocument.
      • concealValueOnDocumentMetadata

        public FormulaTab concealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        concealValueOnDocumentMetadata.
        Returns:
        FormulaTab
      • getConcealValueOnDocumentMetadata

        public PropertyMetadata getConcealValueOnDocumentMetadata()
        Metadata that indicates whether the `concealValueOnDocument` property is editable..
        Returns:
        concealValueOnDocumentMetadata
      • setConcealValueOnDocumentMetadata

        public void setConcealValueOnDocumentMetadata​(PropertyMetadata concealValueOnDocumentMetadata)
        setConcealValueOnDocumentMetadata.
      • conditionalParentLabel

        public FormulaTab conditionalParentLabel​(String conditionalParentLabel)
        conditionalParentLabel.
        Returns:
        FormulaTab
      • getConditionalParentLabel

        public String getConditionalParentLabel()
        For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..
        Returns:
        conditionalParentLabel
      • setConditionalParentLabel

        public void setConditionalParentLabel​(String conditionalParentLabel)
        setConditionalParentLabel.
      • conditionalParentLabelMetadata

        public FormulaTab conditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        conditionalParentLabelMetadata.
        Returns:
        FormulaTab
      • getConditionalParentLabelMetadata

        public PropertyMetadata getConditionalParentLabelMetadata()
        Metadata that indicates whether the `conditionalParentLabel` property is editable..
        Returns:
        conditionalParentLabelMetadata
      • setConditionalParentLabelMetadata

        public void setConditionalParentLabelMetadata​(PropertyMetadata conditionalParentLabelMetadata)
        setConditionalParentLabelMetadata.
      • conditionalParentValue

        public FormulaTab conditionalParentValue​(String conditionalParentValue)
        conditionalParentValue.
        Returns:
        FormulaTab
      • getConditionalParentValue

        public String getConditionalParentValue()
        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 Signature, or Optional Initial use \"on\" as the value to show that the parent tab is active. .
        Returns:
        conditionalParentValue
      • setConditionalParentValue

        public void setConditionalParentValue​(String conditionalParentValue)
        setConditionalParentValue.
      • conditionalParentValueMetadata

        public FormulaTab conditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        conditionalParentValueMetadata.
        Returns:
        FormulaTab
      • getConditionalParentValueMetadata

        public PropertyMetadata getConditionalParentValueMetadata()
        Metadata that indicates whether the `conditionalParentValue` property is editable..
        Returns:
        conditionalParentValueMetadata
      • setConditionalParentValueMetadata

        public void setConditionalParentValueMetadata​(PropertyMetadata conditionalParentValueMetadata)
        setConditionalParentValueMetadata.
      • connectedObjectDetails

        public FormulaTab connectedObjectDetails​(ConnectedObjectDetails connectedObjectDetails)
        connectedObjectDetails.
        Returns:
        FormulaTab
      • getConnectedObjectDetails

        public ConnectedObjectDetails getConnectedObjectDetails()
        .
        Returns:
        connectedObjectDetails
      • setConnectedObjectDetails

        public void setConnectedObjectDetails​(ConnectedObjectDetails connectedObjectDetails)
        setConnectedObjectDetails.
      • customTabId

        public FormulaTab customTabId​(String customTabId)
        customTabId.
        Returns:
        FormulaTab
      • getCustomTabId

        public String getCustomTabId()
        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..
        Returns:
        customTabId
      • setCustomTabId

        public void setCustomTabId​(String customTabId)
        setCustomTabId.
      • customTabIdMetadata

        public FormulaTab customTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        customTabIdMetadata.
        Returns:
        FormulaTab
      • getCustomTabIdMetadata

        public PropertyMetadata getCustomTabIdMetadata()
        Metadata that indicates whether the `customTabId` property is editable..
        Returns:
        customTabIdMetadata
      • setCustomTabIdMetadata

        public void setCustomTabIdMetadata​(PropertyMetadata customTabIdMetadata)
        setCustomTabIdMetadata.
      • disableAutoSize

        public FormulaTab disableAutoSize​(String disableAutoSize)
        disableAutoSize.
        Returns:
        FormulaTab
      • getDisableAutoSize

        public String getDisableAutoSize()
        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..
        Returns:
        disableAutoSize
      • setDisableAutoSize

        public void setDisableAutoSize​(String disableAutoSize)
        setDisableAutoSize.
      • disableAutoSizeMetadata

        public FormulaTab disableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        disableAutoSizeMetadata.
        Returns:
        FormulaTab
      • getDisableAutoSizeMetadata

        public PropertyMetadata getDisableAutoSizeMetadata()
        Metadata that indicates whether the `disableAutoSize` property is editable..
        Returns:
        disableAutoSizeMetadata
      • setDisableAutoSizeMetadata

        public void setDisableAutoSizeMetadata​(PropertyMetadata disableAutoSizeMetadata)
        setDisableAutoSizeMetadata.
      • documentId

        public FormulaTab documentId​(String documentId)
        documentId.
        Returns:
        FormulaTab
      • getDocumentId

        public String getDocumentId()
        Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
        Returns:
        documentId
      • setDocumentId

        public void setDocumentId​(String documentId)
        setDocumentId.
      • documentIdMetadata

        public FormulaTab documentIdMetadata​(PropertyMetadata documentIdMetadata)
        documentIdMetadata.
        Returns:
        FormulaTab
      • getDocumentIdMetadata

        public PropertyMetadata getDocumentIdMetadata()
        Metadata that indicates whether the `documentId` property is editable..
        Returns:
        documentIdMetadata
      • setDocumentIdMetadata

        public void setDocumentIdMetadata​(PropertyMetadata documentIdMetadata)
        setDocumentIdMetadata.
      • errorDetails

        public FormulaTab errorDetails​(ErrorDetails errorDetails)
        errorDetails.
        Returns:
        FormulaTab
      • getErrorDetails

        public ErrorDetails getErrorDetails()
        Array or errors..
        Returns:
        errorDetails
      • setErrorDetails

        public void setErrorDetails​(ErrorDetails errorDetails)
        setErrorDetails.
      • extensionData

        public FormulaTab extensionData​(ExtensionData extensionData)
        extensionData.
        Returns:
        FormulaTab
      • getExtensionData

        public ExtensionData getExtensionData()
        .
        Returns:
        extensionData
      • setExtensionData

        public void setExtensionData​(ExtensionData extensionData)
        setExtensionData.
      • getFont

        public String getFont()
        The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..
        Returns:
        font
      • setFont

        public void setFont​(String font)
        setFont.
      • fontColor

        public FormulaTab fontColor​(String fontColor)
        fontColor.
        Returns:
        FormulaTab
      • getFontColor

        public String getFontColor()
        The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
        Returns:
        fontColor
      • setFontColor

        public void setFontColor​(String fontColor)
        setFontColor.
      • fontColorMetadata

        public FormulaTab fontColorMetadata​(PropertyMetadata fontColorMetadata)
        fontColorMetadata.
        Returns:
        FormulaTab
      • getFontColorMetadata

        public PropertyMetadata getFontColorMetadata()
        Metadata that indicates whether the `fontColor` property is editable..
        Returns:
        fontColorMetadata
      • setFontColorMetadata

        public void setFontColorMetadata​(PropertyMetadata fontColorMetadata)
        setFontColorMetadata.
      • getFontMetadata

        public PropertyMetadata getFontMetadata()
        Metadata that indicates whether the `font` property is editable..
        Returns:
        fontMetadata
      • setFontMetadata

        public void setFontMetadata​(PropertyMetadata fontMetadata)
        setFontMetadata.
      • fontSize

        public FormulaTab fontSize​(String fontSize)
        fontSize.
        Returns:
        FormulaTab
      • getFontSize

        public String getFontSize()
        The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72..
        Returns:
        fontSize
      • setFontSize

        public void setFontSize​(String fontSize)
        setFontSize.
      • fontSizeMetadata

        public FormulaTab fontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        fontSizeMetadata.
        Returns:
        FormulaTab
      • getFontSizeMetadata

        public PropertyMetadata getFontSizeMetadata()
        Metadata that indicates whether the `fontSize` property is editable..
        Returns:
        fontSizeMetadata
      • setFontSizeMetadata

        public void setFontSizeMetadata​(PropertyMetadata fontSizeMetadata)
        setFontSizeMetadata.
      • formOrder

        public FormulaTab formOrder​(String formOrder)
        formOrder.
        Returns:
        FormulaTab
      • getFormOrder

        public String getFormOrder()
        .
        Returns:
        formOrder
      • setFormOrder

        public void setFormOrder​(String formOrder)
        setFormOrder.
      • formOrderMetadata

        public FormulaTab formOrderMetadata​(PropertyMetadata formOrderMetadata)
        formOrderMetadata.
        Returns:
        FormulaTab
      • getFormOrderMetadata

        public PropertyMetadata getFormOrderMetadata()
        Metadata that indicates whether the `formOrder` property is editable..
        Returns:
        formOrderMetadata
      • setFormOrderMetadata

        public void setFormOrderMetadata​(PropertyMetadata formOrderMetadata)
        setFormOrderMetadata.
      • formPageLabel

        public FormulaTab formPageLabel​(String formPageLabel)
        formPageLabel.
        Returns:
        FormulaTab
      • getFormPageLabel

        public String getFormPageLabel()
        .
        Returns:
        formPageLabel
      • setFormPageLabel

        public void setFormPageLabel​(String formPageLabel)
        setFormPageLabel.
      • formPageLabelMetadata

        public FormulaTab formPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        formPageLabelMetadata.
        Returns:
        FormulaTab
      • getFormPageLabelMetadata

        public PropertyMetadata getFormPageLabelMetadata()
        Metadata that indicates whether the `formPageLabel` property is editable..
        Returns:
        formPageLabelMetadata
      • setFormPageLabelMetadata

        public void setFormPageLabelMetadata​(PropertyMetadata formPageLabelMetadata)
        setFormPageLabelMetadata.
      • formPageNumber

        public FormulaTab formPageNumber​(String formPageNumber)
        formPageNumber.
        Returns:
        FormulaTab
      • getFormPageNumber

        public String getFormPageNumber()
        .
        Returns:
        formPageNumber
      • setFormPageNumber

        public void setFormPageNumber​(String formPageNumber)
        setFormPageNumber.
      • formPageNumberMetadata

        public FormulaTab formPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        formPageNumberMetadata.
        Returns:
        FormulaTab
      • getFormPageNumberMetadata

        public PropertyMetadata getFormPageNumberMetadata()
        Metadata that indicates whether the `fromPageNumber` property is editable..
        Returns:
        formPageNumberMetadata
      • setFormPageNumberMetadata

        public void setFormPageNumberMetadata​(PropertyMetadata formPageNumberMetadata)
        setFormPageNumberMetadata.
      • formula

        public FormulaTab formula​(String formula)
        formula.
        Returns:
        FormulaTab
      • getFormula

        public String getFormula()
        The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Maximum Length: 2000 characters. *Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: [Line1]+[Line2]+[Tax].
        Returns:
        formula
      • setFormula

        public void setFormula​(String formula)
        setFormula.
      • getFormulaMetadata

        public PropertyMetadata getFormulaMetadata()
        Metadata indicating if the sender can edit the `formula` property..
        Returns:
        formulaMetadata
      • setFormulaMetadata

        public void setFormulaMetadata​(PropertyMetadata formulaMetadata)
        setFormulaMetadata.
      • height

        public FormulaTab height​(String height)
        height.
        Returns:
        FormulaTab
      • getHeight

        public String getHeight()
        Height of the tab in pixels..
        Returns:
        height
      • setHeight

        public void setHeight​(String height)
        setHeight.
      • getHeightMetadata

        public PropertyMetadata getHeightMetadata()
        Metadata that indicates whether the `height` property is editable..
        Returns:
        heightMetadata
      • setHeightMetadata

        public void setHeightMetadata​(PropertyMetadata heightMetadata)
        setHeightMetadata.
      • hidden

        public FormulaTab hidden​(String hidden)
        hidden.
        Returns:
        FormulaTab
      • getHidden

        public String getHidden()
        .
        Returns:
        hidden
      • setHidden

        public void setHidden​(String hidden)
        setHidden.
      • getHiddenMetadata

        public PropertyMetadata getHiddenMetadata()
        Metadata that indicates whether the `hidden` property is editable..
        Returns:
        hiddenMetadata
      • setHiddenMetadata

        public void setHiddenMetadata​(PropertyMetadata hiddenMetadata)
        setHiddenMetadata.
      • isPaymentAmount

        public FormulaTab isPaymentAmount​(String isPaymentAmount)
        isPaymentAmount.
        Returns:
        FormulaTab
      • getIsPaymentAmount

        public String getIsPaymentAmount()
        When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. .
        Returns:
        isPaymentAmount
      • setIsPaymentAmount

        public void setIsPaymentAmount​(String isPaymentAmount)
        setIsPaymentAmount.
      • isPaymentAmountMetadata

        public FormulaTab isPaymentAmountMetadata​(PropertyMetadata isPaymentAmountMetadata)
        isPaymentAmountMetadata.
        Returns:
        FormulaTab
      • getIsPaymentAmountMetadata

        public PropertyMetadata getIsPaymentAmountMetadata()
        Reserved for DocuSign..
        Returns:
        isPaymentAmountMetadata
      • setIsPaymentAmountMetadata

        public void setIsPaymentAmountMetadata​(PropertyMetadata isPaymentAmountMetadata)
        setIsPaymentAmountMetadata.
      • italic

        public FormulaTab italic​(String italic)
        italic.
        Returns:
        FormulaTab
      • getItalic

        public String getItalic()
        When set to **true**, the information in the tab is italic..
        Returns:
        italic
      • setItalic

        public void setItalic​(String italic)
        setItalic.
      • getItalicMetadata

        public PropertyMetadata getItalicMetadata()
        Metadata that indicates whether the `italic` property is editable..
        Returns:
        italicMetadata
      • setItalicMetadata

        public void setItalicMetadata​(PropertyMetadata italicMetadata)
        setItalicMetadata.
      • getLocalePolicy

        public LocalePolicyTab getLocalePolicy()
        Reserved for DocuSign..
        Returns:
        localePolicy
      • setLocalePolicy

        public void setLocalePolicy​(LocalePolicyTab localePolicy)
        setLocalePolicy.
      • locked

        public FormulaTab locked​(String locked)
        locked.
        Returns:
        FormulaTab
      • getLocked

        public String getLocked()
        When set to **true**, the signer cannot change the data of the custom tab..
        Returns:
        locked
      • setLocked

        public void setLocked​(String locked)
        setLocked.
      • getLockedMetadata

        public PropertyMetadata getLockedMetadata()
        Metadata that indicates whether the `locked` property is editable..
        Returns:
        lockedMetadata
      • setLockedMetadata

        public void setLockedMetadata​(PropertyMetadata lockedMetadata)
        setLockedMetadata.
      • maxLength

        public FormulaTab maxLength​(String maxLength)
        maxLength.
        Returns:
        FormulaTab
      • getMaxLength

        public String getMaxLength()
        An optional value that describes the maximum length of the property when the property is a string..
        Returns:
        maxLength
      • setMaxLength

        public void setMaxLength​(String maxLength)
        setMaxLength.
      • maxLengthMetadata

        public FormulaTab maxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        maxLengthMetadata.
        Returns:
        FormulaTab
      • getMaxLengthMetadata

        public PropertyMetadata getMaxLengthMetadata()
        Metadata that indicates whether the `maxLength` property is editable..
        Returns:
        maxLengthMetadata
      • setMaxLengthMetadata

        public void setMaxLengthMetadata​(PropertyMetadata maxLengthMetadata)
        setMaxLengthMetadata.
      • mergeField

        public FormulaTab mergeField​(MergeField mergeField)
        mergeField.
        Returns:
        FormulaTab
      • getMergeField

        public MergeField getMergeField()
        Contains the information necessary to map the tab to a field in SalesForce..
        Returns:
        mergeField
      • setMergeField

        public void setMergeField​(MergeField mergeField)
        setMergeField.
      • mergeFieldXml

        public FormulaTab mergeFieldXml​(String mergeFieldXml)
        mergeFieldXml.
        Returns:
        FormulaTab
      • getMergeFieldXml

        public String getMergeFieldXml()
        .
        Returns:
        mergeFieldXml
      • setMergeFieldXml

        public void setMergeFieldXml​(String mergeFieldXml)
        setMergeFieldXml.
      • getName

        public String getName()
        .
        Returns:
        name
      • setName

        public void setName​(String name)
        setName.
      • getNameMetadata

        public PropertyMetadata getNameMetadata()
        Metadata that indicates whether the `name` property is editable. This property is read-only..
        Returns:
        nameMetadata
      • setNameMetadata

        public void setNameMetadata​(PropertyMetadata nameMetadata)
        setNameMetadata.
      • originalValue

        public FormulaTab originalValue​(String originalValue)
        originalValue.
        Returns:
        FormulaTab
      • getOriginalValue

        public String getOriginalValue()
        The initial value of the tab when it was sent to the recipient. .
        Returns:
        originalValue
      • setOriginalValue

        public void setOriginalValue​(String originalValue)
        setOriginalValue.
      • originalValueMetadata

        public FormulaTab originalValueMetadata​(PropertyMetadata originalValueMetadata)
        originalValueMetadata.
        Returns:
        FormulaTab
      • getOriginalValueMetadata

        public PropertyMetadata getOriginalValueMetadata()
        Metadata that indicates whether the `originalValue` property is editable..
        Returns:
        originalValueMetadata
      • setOriginalValueMetadata

        public void setOriginalValueMetadata​(PropertyMetadata originalValueMetadata)
        setOriginalValueMetadata.
      • pageNumber

        public FormulaTab pageNumber​(String pageNumber)
        pageNumber.
        Returns:
        FormulaTab
      • getPageNumber

        public String getPageNumber()
        Specifies the page number on which the tab is located..
        Returns:
        pageNumber
      • setPageNumber

        public void setPageNumber​(String pageNumber)
        setPageNumber.
      • pageNumberMetadata

        public FormulaTab pageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        pageNumberMetadata.
        Returns:
        FormulaTab
      • getPageNumberMetadata

        public PropertyMetadata getPageNumberMetadata()
        Metadata that indicates whether the `pageNumber` property is editable..
        Returns:
        pageNumberMetadata
      • setPageNumberMetadata

        public void setPageNumberMetadata​(PropertyMetadata pageNumberMetadata)
        setPageNumberMetadata.
      • paymentDetails

        public FormulaTab paymentDetails​(PaymentDetails paymentDetails)
        paymentDetails.
        Returns:
        FormulaTab
      • getPaymentDetails

        public PaymentDetails getPaymentDetails()
        This property indicates that this formula tab is a payment item. See [Requesting Payments Along with Signatures][paymentguide] in the DocuSign Support Center to learn more about payments. [paymentguide]: https://support.docusign.com/en/guides/requesting-payments-along-with-signatures .
        Returns:
        paymentDetails
      • setPaymentDetails

        public void setPaymentDetails​(PaymentDetails paymentDetails)
        setPaymentDetails.
      • recipientId

        public FormulaTab recipientId​(String recipientId)
        recipientId.
        Returns:
        FormulaTab
      • getRecipientId

        public String getRecipientId()
        Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
        Returns:
        recipientId
      • setRecipientId

        public void setRecipientId​(String recipientId)
        setRecipientId.
      • recipientIdGuid

        public FormulaTab recipientIdGuid​(String recipientIdGuid)
        recipientIdGuid.
        Returns:
        FormulaTab
      • getRecipientIdGuid

        public String getRecipientIdGuid()
        .
        Returns:
        recipientIdGuid
      • setRecipientIdGuid

        public void setRecipientIdGuid​(String recipientIdGuid)
        setRecipientIdGuid.
      • recipientIdGuidMetadata

        public FormulaTab recipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        recipientIdGuidMetadata.
        Returns:
        FormulaTab
      • getRecipientIdGuidMetadata

        public PropertyMetadata getRecipientIdGuidMetadata()
        Metadata that indicates whether the `recipientIdGuid` property is editable..
        Returns:
        recipientIdGuidMetadata
      • setRecipientIdGuidMetadata

        public void setRecipientIdGuidMetadata​(PropertyMetadata recipientIdGuidMetadata)
        setRecipientIdGuidMetadata.
      • recipientIdMetadata

        public FormulaTab recipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        recipientIdMetadata.
        Returns:
        FormulaTab
      • getRecipientIdMetadata

        public PropertyMetadata getRecipientIdMetadata()
        Metadata that indicates whether the `recipientId` property is editable..
        Returns:
        recipientIdMetadata
      • setRecipientIdMetadata

        public void setRecipientIdMetadata​(PropertyMetadata recipientIdMetadata)
        setRecipientIdMetadata.
      • requireAll

        public FormulaTab requireAll​(String requireAll)
        requireAll.
        Returns:
        FormulaTab
      • getRequireAll

        public String getRequireAll()
        When set to **true** and shared is true, information must be entered in this field to complete the envelope. .
        Returns:
        requireAll
      • setRequireAll

        public void setRequireAll​(String requireAll)
        setRequireAll.
      • requireAllMetadata

        public FormulaTab requireAllMetadata​(PropertyMetadata requireAllMetadata)
        requireAllMetadata.
        Returns:
        FormulaTab
      • getRequireAllMetadata

        public PropertyMetadata getRequireAllMetadata()
        Metadata that indicates whether the `requireAll` property is editable..
        Returns:
        requireAllMetadata
      • setRequireAllMetadata

        public void setRequireAllMetadata​(PropertyMetadata requireAllMetadata)
        setRequireAllMetadata.
      • required

        public FormulaTab required​(String required)
        required.
        Returns:
        FormulaTab
      • getRequired

        public String getRequired()
        When set to **true**, the signer is required to fill out this tab.
        Returns:
        required
      • setRequired

        public void setRequired​(String required)
        setRequired.
      • requiredMetadata

        public FormulaTab requiredMetadata​(PropertyMetadata requiredMetadata)
        requiredMetadata.
        Returns:
        FormulaTab
      • getRequiredMetadata

        public PropertyMetadata getRequiredMetadata()
        Metadata that indicates whether the `required` property is editable..
        Returns:
        requiredMetadata
      • setRequiredMetadata

        public void setRequiredMetadata​(PropertyMetadata requiredMetadata)
        setRequiredMetadata.
      • requireInitialOnSharedChange

        public FormulaTab requireInitialOnSharedChange​(String requireInitialOnSharedChange)
        requireInitialOnSharedChange.
        Returns:
        FormulaTab
      • getRequireInitialOnSharedChange

        public String getRequireInitialOnSharedChange()
        Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field..
        Returns:
        requireInitialOnSharedChange
      • setRequireInitialOnSharedChange

        public void setRequireInitialOnSharedChange​(String requireInitialOnSharedChange)
        setRequireInitialOnSharedChange.
      • requireInitialOnSharedChangeMetadata

        public FormulaTab requireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        requireInitialOnSharedChangeMetadata.
        Returns:
        FormulaTab
      • getRequireInitialOnSharedChangeMetadata

        public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
        Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
        Returns:
        requireInitialOnSharedChangeMetadata
      • setRequireInitialOnSharedChangeMetadata

        public void setRequireInitialOnSharedChangeMetadata​(PropertyMetadata requireInitialOnSharedChangeMetadata)
        setRequireInitialOnSharedChangeMetadata.
      • roundDecimalPlaces

        public FormulaTab roundDecimalPlaces​(String roundDecimalPlaces)
        roundDecimalPlaces.
        Returns:
        FormulaTab
      • getRoundDecimalPlaces

        public String getRoundDecimalPlaces()
        .
        Returns:
        roundDecimalPlaces
      • setRoundDecimalPlaces

        public void setRoundDecimalPlaces​(String roundDecimalPlaces)
        setRoundDecimalPlaces.
      • roundDecimalPlacesMetadata

        public FormulaTab roundDecimalPlacesMetadata​(PropertyMetadata roundDecimalPlacesMetadata)
        roundDecimalPlacesMetadata.
        Returns:
        FormulaTab
      • getRoundDecimalPlacesMetadata

        public PropertyMetadata getRoundDecimalPlacesMetadata()
        Metadata that indicates whether the `roundDecimalPlaces` property is editable..
        Returns:
        roundDecimalPlacesMetadata
      • setRoundDecimalPlacesMetadata

        public void setRoundDecimalPlacesMetadata​(PropertyMetadata roundDecimalPlacesMetadata)
        setRoundDecimalPlacesMetadata.
      • senderRequired

        public FormulaTab senderRequired​(String senderRequired)
        senderRequired.
        Returns:
        FormulaTab
      • getSenderRequired

        public String getSenderRequired()
        When set to **true**, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope..
        Returns:
        senderRequired
      • setSenderRequired

        public void setSenderRequired​(String senderRequired)
        setSenderRequired.
      • senderRequiredMetadata

        public FormulaTab senderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        senderRequiredMetadata.
        Returns:
        FormulaTab
      • getSenderRequiredMetadata

        public PropertyMetadata getSenderRequiredMetadata()
        Metadata that indicates whether the `senderRequired` property is editable..
        Returns:
        senderRequiredMetadata
      • setSenderRequiredMetadata

        public void setSenderRequiredMetadata​(PropertyMetadata senderRequiredMetadata)
        setSenderRequiredMetadata.
      • shared

        public FormulaTab shared​(String shared)
        shared.
        Returns:
        FormulaTab
      • getShared

        public String getShared()
        When set to **true**, this custom tab is shared..
        Returns:
        shared
      • setShared

        public void setShared​(String shared)
        setShared.
      • getSharedMetadata

        public PropertyMetadata getSharedMetadata()
        Metadata that indicates whether the `shared` property is editable..
        Returns:
        sharedMetadata
      • setSharedMetadata

        public void setSharedMetadata​(PropertyMetadata sharedMetadata)
        setSharedMetadata.
      • shareToRecipients

        public FormulaTab shareToRecipients​(String shareToRecipients)
        shareToRecipients.
        Returns:
        FormulaTab
      • getShareToRecipients

        public String getShareToRecipients()
        .
        Returns:
        shareToRecipients
      • setShareToRecipients

        public void setShareToRecipients​(String shareToRecipients)
        setShareToRecipients.
      • shareToRecipientsMetadata

        public FormulaTab shareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        shareToRecipientsMetadata.
        Returns:
        FormulaTab
      • getShareToRecipientsMetadata

        public PropertyMetadata getShareToRecipientsMetadata()
        Reserved for DocuSign..
        Returns:
        shareToRecipientsMetadata
      • setShareToRecipientsMetadata

        public void setShareToRecipientsMetadata​(PropertyMetadata shareToRecipientsMetadata)
        setShareToRecipientsMetadata.
      • smartContractInformation

        public FormulaTab smartContractInformation​(SmartContractInformation smartContractInformation)
        smartContractInformation.
        Returns:
        FormulaTab
      • getSmartContractInformation

        public SmartContractInformation getSmartContractInformation()
        Reserved for DocuSign..
        Returns:
        smartContractInformation
      • setSmartContractInformation

        public void setSmartContractInformation​(SmartContractInformation smartContractInformation)
        setSmartContractInformation.
      • source

        public FormulaTab source​(String source)
        source.
        Returns:
        FormulaTab
      • getSource

        public String getSource()
        .
        Returns:
        source
      • setSource

        public void setSource​(String source)
        setSource.
      • status

        public FormulaTab status​(String status)
        status.
        Returns:
        FormulaTab
      • getStatus

        public String getStatus()
        Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
        Returns:
        status
      • setStatus

        public void setStatus​(String status)
        setStatus.
      • getStatusMetadata

        public PropertyMetadata getStatusMetadata()
        Metadata that indicates whether the `status` property is editable..
        Returns:
        statusMetadata
      • setStatusMetadata

        public void setStatusMetadata​(PropertyMetadata statusMetadata)
        setStatusMetadata.
      • tabFullyQualifiedPath

        public FormulaTab tabFullyQualifiedPath​(String tabFullyQualifiedPath)
        tabFullyQualifiedPath.
        Returns:
        FormulaTab
      • getTabFullyQualifiedPath

        public String getTabFullyQualifiedPath()
        .
        Returns:
        tabFullyQualifiedPath
      • setTabFullyQualifiedPath

        public void setTabFullyQualifiedPath​(String tabFullyQualifiedPath)
        setTabFullyQualifiedPath.
      • tabGroupLabels

        public FormulaTab tabGroupLabels​(List<String> tabGroupLabels)
        tabGroupLabels.
        Returns:
        FormulaTab
      • addTabGroupLabelsItem

        public FormulaTab addTabGroupLabelsItem​(String tabGroupLabelsItem)
        addTabGroupLabelsItem.
        Returns:
        FormulaTab
      • getTabGroupLabels

        public List<String> getTabGroupLabels()
        .
        Returns:
        tabGroupLabels
      • setTabGroupLabels

        public void setTabGroupLabels​(List<String> tabGroupLabels)
        setTabGroupLabels.
      • tabGroupLabelsMetadata

        public FormulaTab tabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        tabGroupLabelsMetadata.
        Returns:
        FormulaTab
      • getTabGroupLabelsMetadata

        public PropertyMetadata getTabGroupLabelsMetadata()
        Metadata that indicates whether the `tabGroupLabels` property is editable..
        Returns:
        tabGroupLabelsMetadata
      • setTabGroupLabelsMetadata

        public void setTabGroupLabelsMetadata​(PropertyMetadata tabGroupLabelsMetadata)
        setTabGroupLabelsMetadata.
      • getTabId

        public String getTabId()
        The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .
        Returns:
        tabId
      • setTabId

        public void setTabId​(String tabId)
        setTabId.
      • getTabIdMetadata

        public PropertyMetadata getTabIdMetadata()
        Metadata that indicates whether the `tabId` property is editable..
        Returns:
        tabIdMetadata
      • setTabIdMetadata

        public void setTabIdMetadata​(PropertyMetadata tabIdMetadata)
        setTabIdMetadata.
      • tabLabel

        public FormulaTab tabLabel​(String tabLabel)
        tabLabel.
        Returns:
        FormulaTab
      • getTabLabel

        public String getTabLabel()
        The label string associated with the tab..
        Returns:
        tabLabel
      • setTabLabel

        public void setTabLabel​(String tabLabel)
        setTabLabel.
      • tabLabelMetadata

        public FormulaTab tabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        tabLabelMetadata.
        Returns:
        FormulaTab
      • getTabLabelMetadata

        public PropertyMetadata getTabLabelMetadata()
        Metadata that indicates whether the `tabLabel` property is editable..
        Returns:
        tabLabelMetadata
      • setTabLabelMetadata

        public void setTabLabelMetadata​(PropertyMetadata tabLabelMetadata)
        setTabLabelMetadata.
      • tabOrder

        public FormulaTab tabOrder​(String tabOrder)
        tabOrder.
        Returns:
        FormulaTab
      • getTabOrder

        public String getTabOrder()
        .
        Returns:
        tabOrder
      • setTabOrder

        public void setTabOrder​(String tabOrder)
        setTabOrder.
      • tabOrderMetadata

        public FormulaTab tabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        tabOrderMetadata.
        Returns:
        FormulaTab
      • getTabOrderMetadata

        public PropertyMetadata getTabOrderMetadata()
        Metadata that indicates whether the `tabOrder` property is editable..
        Returns:
        tabOrderMetadata
      • setTabOrderMetadata

        public void setTabOrderMetadata​(PropertyMetadata tabOrderMetadata)
        setTabOrderMetadata.
      • tabType

        public FormulaTab tabType​(String tabType)
        tabType.
        Returns:
        FormulaTab
      • getTabType

        public String getTabType()
        .
        Returns:
        tabType
      • setTabType

        public void setTabType​(String tabType)
        setTabType.
      • getTabTypeMetadata

        public PropertyMetadata getTabTypeMetadata()
        Metadata that indicates whether the `tabType` property is editable..
        Returns:
        tabTypeMetadata
      • setTabTypeMetadata

        public void setTabTypeMetadata​(PropertyMetadata tabTypeMetadata)
        setTabTypeMetadata.
      • templateLocked

        public FormulaTab templateLocked​(String templateLocked)
        templateLocked.
        Returns:
        FormulaTab
      • getTemplateLocked

        public String getTemplateLocked()
        When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
        Returns:
        templateLocked
      • setTemplateLocked

        public void setTemplateLocked​(String templateLocked)
        setTemplateLocked.
      • templateLockedMetadata

        public FormulaTab templateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        templateLockedMetadata.
        Returns:
        FormulaTab
      • getTemplateLockedMetadata

        public PropertyMetadata getTemplateLockedMetadata()
        Metadata that indicates whether the `templateLocked` property is editable..
        Returns:
        templateLockedMetadata
      • setTemplateLockedMetadata

        public void setTemplateLockedMetadata​(PropertyMetadata templateLockedMetadata)
        setTemplateLockedMetadata.
      • templateRequired

        public FormulaTab templateRequired​(String templateRequired)
        templateRequired.
        Returns:
        FormulaTab
      • getTemplateRequired

        public String getTemplateRequired()
        When set to **true**, the sender may not remove the recipient. Used only when working with template recipients..
        Returns:
        templateRequired
      • setTemplateRequired

        public void setTemplateRequired​(String templateRequired)
        setTemplateRequired.
      • templateRequiredMetadata

        public FormulaTab templateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        templateRequiredMetadata.
        Returns:
        FormulaTab
      • getTemplateRequiredMetadata

        public PropertyMetadata getTemplateRequiredMetadata()
        Metadata that indicates whether the `templateRequired` property is editable..
        Returns:
        templateRequiredMetadata
      • setTemplateRequiredMetadata

        public void setTemplateRequiredMetadata​(PropertyMetadata templateRequiredMetadata)
        setTemplateRequiredMetadata.
      • tooltip

        public FormulaTab tooltip​(String tooltip)
        tooltip.
        Returns:
        FormulaTab
      • getTooltip

        public String getTooltip()
        .
        Returns:
        tooltip
      • setTooltip

        public void setTooltip​(String tooltip)
        setTooltip.
      • getToolTipMetadata

        public PropertyMetadata getToolTipMetadata()
        Metadata that indicates whether the `toolTip` property is editable..
        Returns:
        toolTipMetadata
      • setToolTipMetadata

        public void setToolTipMetadata​(PropertyMetadata toolTipMetadata)
        setToolTipMetadata.
      • underline

        public FormulaTab underline​(String underline)
        underline.
        Returns:
        FormulaTab
      • getUnderline

        public String getUnderline()
        When set to **true**, the information in the tab is underlined..
        Returns:
        underline
      • setUnderline

        public void setUnderline​(String underline)
        setUnderline.
      • underlineMetadata

        public FormulaTab underlineMetadata​(PropertyMetadata underlineMetadata)
        underlineMetadata.
        Returns:
        FormulaTab
      • getUnderlineMetadata

        public PropertyMetadata getUnderlineMetadata()
        Metadata that indicates whether the `underline` property is editable..
        Returns:
        underlineMetadata
      • setUnderlineMetadata

        public void setUnderlineMetadata​(PropertyMetadata underlineMetadata)
        setUnderlineMetadata.
      • validationMessage

        public FormulaTab validationMessage​(String validationMessage)
        validationMessage.
        Returns:
        FormulaTab
      • getValidationMessage

        public String getValidationMessage()
        The message displayed if the custom tab fails input validation (either custom of embedded)..
        Returns:
        validationMessage
      • setValidationMessage

        public void setValidationMessage​(String validationMessage)
        setValidationMessage.
      • validationMessageMetadata

        public FormulaTab validationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        validationMessageMetadata.
        Returns:
        FormulaTab
      • getValidationMessageMetadata

        public PropertyMetadata getValidationMessageMetadata()
        Metadata that indicates whether the `validationMessage` property is editable..
        Returns:
        validationMessageMetadata
      • setValidationMessageMetadata

        public void setValidationMessageMetadata​(PropertyMetadata validationMessageMetadata)
        setValidationMessageMetadata.
      • validationPattern

        public FormulaTab validationPattern​(String validationPattern)
        validationPattern.
        Returns:
        FormulaTab
      • getValidationPattern

        public String getValidationPattern()
        A regular expression used to validate input for the tab..
        Returns:
        validationPattern
      • setValidationPattern

        public void setValidationPattern​(String validationPattern)
        setValidationPattern.
      • validationPatternMetadata

        public FormulaTab validationPatternMetadata​(PropertyMetadata validationPatternMetadata)
        validationPatternMetadata.
        Returns:
        FormulaTab
      • getValidationPatternMetadata

        public PropertyMetadata getValidationPatternMetadata()
        Metadata that indicates whether the `validationPattern` property is editable..
        Returns:
        validationPatternMetadata
      • setValidationPatternMetadata

        public void setValidationPatternMetadata​(PropertyMetadata validationPatternMetadata)
        setValidationPatternMetadata.
      • getValue

        public String getValue()
        Specifies the value of the tab. .
        Returns:
        value
      • setValue

        public void setValue​(String value)
        setValue.
      • getValueMetadata

        public PropertyMetadata getValueMetadata()
        Metadata that indicates whether the `value` property is editable..
        Returns:
        valueMetadata
      • setValueMetadata

        public void setValueMetadata​(PropertyMetadata valueMetadata)
        setValueMetadata.
      • warningDetails

        public FormulaTab warningDetails​(ErrorDetails warningDetails)
        warningDetails.
        Returns:
        FormulaTab
      • getWarningDetails

        public ErrorDetails getWarningDetails()
        .
        Returns:
        warningDetails
      • setWarningDetails

        public void setWarningDetails​(ErrorDetails warningDetails)
        setWarningDetails.
      • getWidth

        public String getWidth()
        Width of the tab in pixels..
        Returns:
        width
      • setWidth

        public void setWidth​(String width)
        setWidth.
      • getWidthMetadata

        public PropertyMetadata getWidthMetadata()
        Metadata that indicates whether the `width` property is editable..
        Returns:
        widthMetadata
      • setWidthMetadata

        public void setWidthMetadata​(PropertyMetadata widthMetadata)
        setWidthMetadata.
      • xPosition

        public FormulaTab xPosition​(String xPosition)
        xPosition.
        Returns:
        FormulaTab
      • getXPosition

        public String getXPosition()
        This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        xPosition
      • setXPosition

        public void setXPosition​(String xPosition)
        setXPosition.
      • xPositionMetadata

        public FormulaTab xPositionMetadata​(PropertyMetadata xPositionMetadata)
        xPositionMetadata.
        Returns:
        FormulaTab
      • getXPositionMetadata

        public PropertyMetadata getXPositionMetadata()
        Metadata that indicates whether the `xPosition` property is editable..
        Returns:
        xPositionMetadata
      • setXPositionMetadata

        public void setXPositionMetadata​(PropertyMetadata xPositionMetadata)
        setXPositionMetadata.
      • yPosition

        public FormulaTab yPosition​(String yPosition)
        yPosition.
        Returns:
        FormulaTab
      • getYPosition

        public String getYPosition()
        This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position..
        Returns:
        yPosition
      • setYPosition

        public void setYPosition​(String yPosition)
        setYPosition.
      • yPositionMetadata

        public FormulaTab yPositionMetadata​(PropertyMetadata yPositionMetadata)
        yPositionMetadata.
        Returns:
        FormulaTab
      • getYPositionMetadata

        public PropertyMetadata getYPositionMetadata()
        Metadata that indicates whether the `yPosition` property is editable..
        Returns:
        yPositionMetadata
      • setYPositionMetadata

        public void setYPositionMetadata​(PropertyMetadata yPositionMetadata)
        setYPositionMetadata.
      • equals

        public boolean equals​(Object o)
        Compares objects.
        Overrides:
        equals in class Object
        Returns:
        true or false depending on comparison result.
      • hashCode

        public int hashCode()
        Returns the HashCode.
        Overrides:
        hashCode in class Object
      • toString

        public String toString()
        Converts the given object to string.
        Overrides:
        toString in class Object