module:model/Tabs

module:model/Tabs

new module:model/Tabs()

Source:

Constructs a new Tabs.
Tabs indicate to recipients where they should sign, initial, or enter data on a document. They are represented graphically as symbols on documents at the time of signing. Tabs can also display data to the recipients.

Members

(inner) approveTabs :Array.<module:model/Approve>

Source:

Specifies a tag on the document where you want the recipient to approve documents in an envelope without placing a signature or initials on the document. If the recipient clicks the Approve tag during the signing process, the recipient is considered to have signed the document. No information is shown on the document for the approval, but it is recorded as a signature in the envelope history.

Type:

(inner) checkboxTabs :Array.<module:model/Checkbox>

Source:

Specifies a tag on the document in a location where the recipient can select an option.

Type:

(inner) commentThreadTabs :Array.<module:model/CommentThread>

Source:
Type:

(inner) commissionCountyTabs :Array.<module:model/CommissionCounty>

Source:
Type:

(inner) commissionExpirationTabs :Array.<module:model/CommissionExpiration>

Source:
Type:

(inner) commissionNumberTabs :Array.<module:model/CommissionNumber>

Source:
Type:

(inner) commissionStateTabs :Array.<module:model/CommissionState>

Source:
Type:

(inner) companyTabs :Array.<module:model/Company>

Source:

Specifies a tag on the document where you want the recipient's company name to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) dateSignedTabs :Array.<module:model/DateSigned>

Source:

Specifies a tab on the document where the date the document was signed will automatically appear.

Type:

(inner) dateTabs :Array.<module:model/ModelDate>

Source:

Specifies a tab on the document where you want the recipient to enter a date. Date tabs are single-line fields that allow date information to be entered in any format. The tooltip for this tab recommends entering the date as MM/DD/YYYY, but this is not enforced. The format entered by the signer is retained. If you need a particular date format enforced, DocuSign recommends using a Text tab with a Validation Pattern and Validation Message to enforce the format.

Type:

(inner) declineTabs :Array.<module:model/Decline>

Source:

Specifies a tag on the document where you want to give the recipient the option of declining an envelope. If the recipient clicks the Decline tag during the signing process, the envelope is voided.

Type:

(inner) drawTabs :Array.<module:model/Draw>

Source:
Type:

(inner) emailAddressTabs :Array.<module:model/EmailAddress>

Source:

Specifies a location on the document where you want where you want the recipient's email, as entered in the recipient information, to display.

Type:

(inner) emailTabs :Array.<module:model/Email>

Source:

Specifies a tag on the document where you want the recipient to enter an email. Email tags are single-line fields that accept any characters. The system checks that a valid email format (i.e. xxx@yyy.zzz) is entered in the tag. It uses the same parameters as a Text tab, with the validation message and pattern set for email information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) envelopeIdTabs :Array.<module:model/EnvelopeId>

Source:

Specifies a tag on the document where you want the envelope ID for to appear. Recipients cannot enter or change the information in this tab, it is for informational purposes only.

Type:

(inner) firstNameTabs :Array.<module:model/FirstName>

Source:

Specifies tag on a document where you want the recipient's first name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the first section as the first name.

Type:

(inner) formulaTabs :Array.<module:model/FormulaTab>

Source:

Specifies a tag that is used to add a calculated field to a document. Envelope recipients cannot directly enter information into the tag; the formula tab calculates and displays a new value when changes are made to the reference tag values. The reference tag information and calculation operations are entered in the "formula" element. See the [ML:Using the Calculated Fields Feature] quick start guide or [ML:DocuSign Service User Guide] for more information about formulas.

Type:

(inner) fullNameTabs :Array.<module:model/FullName>

Source:

Specifies a tag on the document where you want the recipient's name to appear.

Type:

(inner) initialHereTabs :Array.<module:model/InitialHere>

Source:

Specifies a tag location in the document at which a recipient will place their initials. The optional parameter specifies whether the initials are required or optional.

Type:

(inner) lastNameTabs :Array.<module:model/LastName>

Source:

Specifies a tag on a document where you want the recipient's last name to appear. This tag takes the recipient's name, as entered in the recipient information, splits it into sections based on spaces and uses the last section as the last name.

Type:

(inner) listTabs :Array.<module:model/List>

Source:

Specify this tag to give your recipient a list of options, presented as a drop-down list, from which they can select.

Type:

(inner) notarizeTabs :Array.<module:model/Notarize>

Source:
Type:

(inner) notarySealTabs :Array.<module:model/NotarySeal>

Source:
Type:

(inner) noteTabs :Array.<module:model/Note>

Source:

Specifies a location on the document where you want to place additional information, in the form of a note, for a recipient.

Type:

(inner) numberTabs :Array.<module:model/ModelNumber>

Source:

Specifies a tag on the document where you want the recipient to enter a number. It uses the same parameters as a Text tab, with the validation message and pattern set for number information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) numericalTabs :Array.<module:model/Numerical>

Source:
Type:

(inner) phoneNumberTabs :Array.<module:model/PhoneNumber>

Source:
Type:

(inner) polyLineOverlayTabs :Array.<module:model/PolyLineOverlay>

Source:
Type:

(inner) prefillTabs :module:model/PrefillTabs

Source:

Prefill tabs are tabs that the sender can fill in before the envelope is sent. They are sometimes called sender tags or pre-fill fields. [Pre-Fill Your Own Document Fields][app] describes how prefill tabs work in the web application. [Customize your envelopes with pre-fill fields][catblog] shows how to use prefill tabs in your application using the eSignature SDKs. [app]: https://support.docusign.com/en/guides/ndse-user-guide-prefill-fields [catblog]: https://www.docusign.com/blog/developers/common-api-tasks-customize-your-envelopes-pre-fill-fields

Type:

(inner) radioGroupTabs :Array.<module:model/RadioGroup>

Source:

Specifies a tag on the document in a location where the recipient can select one option from a group of options using a radio button. The radio buttons do not have to be on the same page in a document.

Type:

(inner) signerAttachmentTabs :Array.<module:model/SignerAttachment>

Source:

Specifies a tag on the document when you want the recipient to add supporting documents to an envelope.

Type:

(inner) signHereTabs :Array.<module:model/SignHere>

Source:

A complex type the contains information about the tag that specifies where the recipient places their signature in the document. The "optional" parameter sets if the signature is required or optional.

Type:

(inner) smartSectionTabs :Array.<module:model/SmartSection>

Source:
Type:

(inner) ssnTabs :Array.<module:model/Ssn>

Source:

Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN). A SSN can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for SSN information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) tabGroups :Array.<module:model/TabGroup>

Source:
Type:

(inner) textTabs :Array.<module:model/Text>

Source:

Specifies a that that is an adaptable field that allows the recipient to enter different text information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) titleTabs :Array.<module:model/Title>

Source:

Specifies a tag on the document where you want the recipient's title to appear. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

(inner) viewTabs :Array.<module:model/View>

Source:
Type:

(inner) zipTabs :Array.<module:model/Zip>

Source:

Specifies a tag on the document where you want the recipient to enter a ZIP code. The ZIP code can be a five numbers or the ZIP+4 format with nine numbers. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. When getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

Type:

Methods

(static) constructFromObject(data, obj) → {module:model/Tabs}

Source:

Constructs a Tabs 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/Tabs

Optional instance to populate.
Returns:

The populated Tabs instance.

Type
module:model/Tabs