Members
(inner) anchor :String
- Source:
An optional string that is used to auto-match tabs to strings located in the documents of an envelope.
Type:
- String
(inner) anchorCaseSensitive :String
- Source:
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
Type:
- String
(inner) anchorHorizontalAlignment :String
- Source:
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
Type:
- String
(inner) anchorIgnoreIfNotPresent :String
- Source:
When set to true, this tab is ignored if anchorString is not found in the document.
Type:
- String
(inner) anchorMatchWholeWord :String
- Source:
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.
Type:
- String
(inner) anchorUnits :String
- Source:
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
Type:
- String
(inner) anchorXOffset :String
- Source:
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
Type:
- String
(inner) anchorYOffset :String
- Source:
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
Type:
- String
(inner) bold :String
- Source:
When set to true, the information in the tab is bold.
Type:
- String
(inner) collaborative :String
- Source:
Type:
- String
(inner) concealValueOnDocument :String
- Source:
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.
Type:
- String
(inner) createdByDisplayName :String
- Source:
The user name of the DocuSign user who created this object.
Type:
- String
(inner) createdByUserId :String
- Source:
The userId of the DocuSign user who created this object.
Type:
- String
(inner) customTabId :String
- Source:
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.
Type:
- String
(inner) disableAutoSize :String
- Source:
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.
Type:
- String
(inner) editable :String
- Source:
When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.
Type:
- String
(inner) font :String
- Source:
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.
Type:
- String
(inner) fontColor :String
- Source:
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
Type:
- String
(inner) fontSize :String
- Source:
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.
Type:
- String
(inner) height :String
- Source:
Height of the tab in pixels.
Type:
- String
(inner) includedInEmail :String
- Source:
When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.
Type:
- String
(inner) initialValue :String
- Source:
The original value of the tab.
Type:
- String
(inner) italic :String
- Source:
When set to true, the information in the tab is italic.
Type:
- String
(inner) items :Array.<String>
- Source:
If the tab is a list, this represents the values that are possible for the tab.
Type:
- Array.<String>
(inner) lastModified :String
- Source:
The UTC DateTime this object was last modified. This is in ISO8601 format.
Type:
- String
(inner) lastModifiedByDisplayName :String
- Source:
The User Name of the DocuSign user who last modified this object.
Type:
- String
(inner) lastModifiedByUserId :String
- Source:
The userId of the DocuSign user who last modified this object.
Type:
- String
(inner) localePolicy :module:model/LocalePolicyTab
- Source:
Reserved for DocuSign.
Type:
(inner) locked :String
- Source:
When set to true, the signer cannot change the data of the custom tab.
Type:
- String
(inner) maximumLength :String
- Source:
The maximum number of entry characters supported by the custom tab.
Type:
- String
(inner) maxNumericalValue :String
- Source:
Type:
- String
(inner) mergeField :module:model/MergeField
- Source:
Contains the information necessary to map the tab to a field in SalesForce.
Type:
(inner) minNumericalValue :String
- Source:
Type:
- String
(inner) name :String
- Source:
Type:
- String
(inner) numericalValue :String
- Source:
Type:
- String
(inner) paymentItemCode :String
- Source:
Type:
- String
(inner) paymentItemDescription :String
- Source:
Type:
- String
(inner) paymentItemName :String
- Source:
Type:
- String
(inner) requireAll :String
- Source:
When set to true and shared is true, information must be entered in this field to complete the envelope.
Type:
- String
(inner) required :String
- Source:
When set to true, the signer is required to fill out this tab
Type:
- String
(inner) requireInitialOnSharedChange :String
- Source:
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
Type:
- String
(inner) scaleValue :String
- Source:
Type:
- String
(inner) selected :String
- Source:
Type:
- String
(inner) shared :String
- Source:
When set to true, this custom tab is shared.
Type:
- String
(inner) signatureProviderId :String
- Source:
Type:
- String
(inner) stampType :String
- Source:
Type:
- String
(inner) stampTypeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the stampType property is editable.
Type:
(inner) tabLabel :String
- Source:
The label string associated with the tab.
Type:
- String
(inner) type :String
- Source:
The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.
Type:
- String
(inner) underline :String
- Source:
When set to true, the information in the tab is underlined.
Type:
- String
(inner) validationMessage :String
- Source:
The message displayed if the custom tab fails input validation (either custom of embedded).
Type:
- String
(inner) validationPattern :String
- Source:
A regular expression used to validate input for the tab.
Type:
- String
(inner) validationType :String
- Source:
Type:
- String
(inner) width :String
- Source:
Width of the tab in pixels.
Type:
- String
Methods
(static) constructFromObject(data, obj) → {module:model/TabMetadata}
- Source:
Constructs a TabMetadata from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/TabMetadata | Optional instance to populate. |
Returns:
The populated TabMetadata instance.