Uses of Class
com.docusign.esign.model.TabMetadata

Packages that use TabMetadata

Package	Description
com.docusign.esign.api
com.docusign.esign.model

Uses of TabMetadata in com.docusign.esign.api

Methods in com.docusign.esign.api that return TabMetadata

Modifier and Type	Method and Description
TabMetadata	CustomTabsApi.create(String accountId, TabMetadata tabMetadata) Creates a custom tab.
TabMetadata	CustomTabsApi.get(String accountId, String customTabId) Gets custom tab information.
TabMetadata	CustomTabsApi.update(String accountId, String customTabId, TabMetadata tabMetadata) Updates custom tab information.\n\n Updates the information in a custom tab for the specified account.

Methods in com.docusign.esign.api with parameters of type TabMetadata

Modifier and Type	Method and Description
TabMetadata	CustomTabsApi.create(String accountId, TabMetadata tabMetadata) Creates a custom tab.
TabMetadata	CustomTabsApi.update(String accountId, String customTabId, TabMetadata tabMetadata) Updates custom tab information.\n\n Updates the information in a custom tab for the specified account.

Uses of TabMetadata in com.docusign.esign.model

Methods in com.docusign.esign.model that return TabMetadata

Modifier and Type	Method and Description
TabMetadata	TabMetadata.anchor(String anchor) An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
TabMetadata	TabMetadata.anchorCaseSensitive(String anchorCaseSensitive) When set to **true**, the anchor string does not consider case when matching strings in the document.
TabMetadata	TabMetadata.anchorHorizontalAlignment(String anchorHorizontalAlignment) Specifies the alignment of anchor tabs with anchor strings.
TabMetadata	TabMetadata.anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent) When set to **true**, this tab is ignored if anchorString is not found in the document.
TabMetadata	TabMetadata.anchorMatchWholeWord(String anchorMatchWholeWord) 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**.
TabMetadata	TabMetadata.anchorUnits(String anchorUnits) Specifies units of the X and Y offset.
TabMetadata	TabMetadata.anchorXOffset(String anchorXOffset) Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
TabMetadata	TabMetadata.anchorYOffset(String anchorYOffset) Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
TabMetadata	TabMetadata.bold(String bold) When set to **true**, the information in the tab is bold.
TabMetadata	TabMetadata.concealValueOnDocument(String concealValueOnDocument) 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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
TabMetadata	TabMetadata.createdByDisplayName(String createdByDisplayName) The user name of the DocuSign user who created this object.
TabMetadata	TabMetadata.createdByUserId(String createdByUserId) The userId of the DocuSign user who created this object.
TabMetadata	TabMetadata.customTabId(String customTabId) The DocuSign generated custom tab ID for the custom tab to be applied.
TabMetadata	TabMetadata.disableAutoSize(String disableAutoSize) When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
TabMetadata	TabMetadata.editable(String editable) When set to **true**, the custom tab is editable.
TabMetadata	TabMetadata.font(String font) The font to be used for the tab value.
TabMetadata	TabMetadata.fontColor(String fontColor) The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
TabMetadata	TabMetadata.fontSize(String fontSize) The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
TabMetadata	TabMetadata.height(String height) Height of the tab in pixels.
TabMetadata	TabMetadata.includedInEmail(String includedInEmail) When set to **true**, the tab is included in e-mails related to the envelope on which it exists.
TabMetadata	TabMetadata.initialValue(String initialValue) The original value of the tab.
TabMetadata	TabMetadata.italic(String italic) When set to **true**, the information in the tab is italic.
TabMetadata	TabMetadata.items(List<String> items) If the tab is a list, this represents the values that are possible for the tab.
TabMetadata	TabMetadata.lastModified(String lastModified) The UTC DateTime this object was last modified.
TabMetadata	TabMetadata.lastModifiedByDisplayName(String lastModifiedByDisplayName) The User Name of the DocuSign user who last modified this object.
TabMetadata	TabMetadata.lastModifiedByUserId(String lastModifiedByUserId) The userId of the DocuSign user who last modified this object.
TabMetadata	TabMetadata.locked(String locked) When set to **true**, the signer cannot change the data of the custom tab.
TabMetadata	TabMetadata.maximumLength(String maximumLength) The maximum number of entry characters supported by the custom tab.
TabMetadata	TabMetadata.mergeField(MergeField mergeField)
TabMetadata	TabMetadata.name(String name)
TabMetadata	TabMetadata.required(String required) When set to **true**, the signer is required to fill out this tab
TabMetadata	TabMetadata.shared(String shared) When set to **true**, this custom tab is shared.
TabMetadata	TabMetadata.tabLabel(String tabLabel) The label string associated with the tab.
TabMetadata	TabMetadata.type(String type) The type of this tab.
TabMetadata	TabMetadata.underline(String underline) When set to **true**, the information in the tab is underlined.
TabMetadata	TabMetadata.validationMessage(String validationMessage) The message displayed if the custom tab fails input validation (either custom of embedded).
TabMetadata	TabMetadata.validationPattern(String validationPattern) A regular expressionn used to validate input for the tab.
TabMetadata	TabMetadata.width(String width) Width of the tab in pixels.

Methods in com.docusign.esign.model that return types with arguments of type TabMetadata

Modifier and Type	Method and Description
List<TabMetadata>	TabMetadataList.getTabs()

Method parameters in com.docusign.esign.model with type arguments of type TabMetadata

Modifier and Type	Method and Description
void	TabMetadataList.setTabs(List<TabMetadata> tabs)
TabMetadataList	TabMetadataList.tabs(List<TabMetadata> tabs)