module:model/List

module:model/List

new module:model/List()

Source:

Constructs a new List.
This tab offers a list of options to choose from. The listItems property contains a list of listItem objects to specify the selectable options.

Members

(inner) anchorAllowWhiteSpaceInCharacters :String

Source:
Type:
  • String

(inner) anchorAllowWhiteSpaceInCharactersMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorAllowWhiteSpaceInCharacters property is editable.

Type:

(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) anchorCaseSensitiveMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorCaseSensitive property is editable.

Type:

(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) anchorHorizontalAlignmentMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorHorizontalAlignment property is editable.

Type:

(inner) anchorIgnoreIfNotPresent :String

Source:

When set to true, this tab is ignored if anchorString is not found in the document.

Type:
  • String

(inner) anchorIgnoreIfNotPresentMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorIgnoreIfNotPresent property is editable.

Type:

(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) anchorMatchWholeWordMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorMatchWholeWord property is editable.

Type:

(inner) anchorString :String

Source:

Anchor text information for a radio button.

Type:
  • String

(inner) anchorStringMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorString property is editable.

Type:

(inner) anchorTabProcessorVersion :String

Source:
Type:
  • String

(inner) anchorTabProcessorVersionMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) anchorUnits :String

Source:

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

Type:
  • String

(inner) anchorUnitsMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorUnits property is editable.

Type:

(inner) anchorXOffset :String

Source:

Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.

Type:
  • String

(inner) anchorXOffsetMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorXOffset property is editable.

Type:

(inner) anchorYOffset :String

Source:

Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.

Type:
  • String

(inner) anchorYOffsetMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the anchorYOffset property is editable.

Type:

(inner) bold :String

Source:

When set to true, the information in the tab is bold.

Type:
  • String

(inner) boldMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the bold property is editable.

Type:

(inner) caption :String

Source:
Type:
  • String

(inner) captionMetadata :module:model/PropertyMetadata

Source:
Type:

(inner) conditionalParentLabel :String

Source:

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

Type:
  • String

(inner) conditionalParentLabelMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the conditionalParentLabel property is editable.

Type:

(inner) conditionalParentValue :String

Source:

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.

Type:
  • String

(inner) conditionalParentValueMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the conditionalParentValue property is editable.

Type:

(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) customTabIdMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the customTabId property is editable.

Type:

(inner) documentId :String

Source:

Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.

Type:
  • String

(inner) documentIdMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the documentId property is editable.

Type:

(inner) errorDetails :module:model/ErrorDetails

Source:

Array or errors.

Type:

(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) fontColorMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the fontColor property is editable.

Type:

(inner) fontMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the font property is editable.

Type:

(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) fontSizeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the fontSize property is editable.

Type:

(inner) formOrder :String

Source:
Type:
  • String

(inner) formOrderMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the formOrder property is editable.

Type:

(inner) formPageLabel :String

Source:
Type:
  • String

(inner) formPageLabelMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the formPageLabel property is editable.

Type:

(inner) formPageNumber :String

Source:
Type:
  • String

(inner) formPageNumberMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the fromPageNumber property is editable.

Type:

(inner) height :String

Source:

Height of the tab in pixels.

Type:
  • String

(inner) heightMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the height property is editable.

Type:

(inner) italic :String

Source:

When set to true, the information in the tab is italic.

Type:
  • String

(inner) italicMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the italic property is editable.

Type:

(inner) listItems :Array.<module:model/ListItem>

Source:

The list of values that can be selected by senders. The list values are separated by semi-colons. Example: [one;two;three;four] Maximum Length of listItems: 2048 characters. Maximum Length of items in the list: 100 characters.

Type:

(inner) listSelectedValue :String

Source:
Type:
  • String

(inner) listSelectedValueMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the listSelectedValue property is editable.

Type:

(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) lockedMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the locked property is editable.

Type:

(inner) mergeField :module:model/MergeField

Source:

Contains the information necessary to map the tab to a field in SalesForce.

Type:

(inner) mergeFieldXml :String

Source:
Type:
  • String

(inner) originalValue :String

Source:

The initial value of the tab when it was sent to the recipient.

Type:
  • String

(inner) originalValueMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the originalValue property is editable.

Type:

(inner) pageNumber :String

Source:

Specifies the page number on which the tab is located.

Type:
  • String

(inner) pageNumberMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the pageNumber property is editable.

Type:

(inner) recipientId :String

Source:

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

Type:
  • String

(inner) recipientIdGuid :String

Source:
Type:
  • String

(inner) recipientIdGuidMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the recipientIdGuid property is editable.

Type:

(inner) recipientIdMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the recipientId property is editable.

Type:

(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) requireAllMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the requireAll property is editable.

Type:

(inner) required :String

Source:

When set to true, the signer is required to fill out this tab

Type:
  • String

(inner) requiredMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the required property is editable.

Type:

(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) requireInitialOnSharedChangeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the requireInitialOnSharedChange property is editable.

Type:

(inner) senderRequired :String

Source:

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.

Type:
  • String

(inner) senderRequiredMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the senderRequired property is editable.

Type:

(inner) shared :String

Source:

When set to true, this custom tab is shared.

Type:
  • String

(inner) sharedMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the shared property is editable.

Type:

(inner) shareToRecipients :String

Source:
Type:
  • String

(inner) shareToRecipientsMetadata :module:model/PropertyMetadata

Source:

Reserved for DocuSign.

Type:

(inner) smartContractInformation :module:model/SmartContractInformation

Source:

Reserved for DocuSign.

Type:

(inner) source :String

Source:
Type:
  • String

(inner) status :String

Source:

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.

Type:
  • String

(inner) statusMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the status property is editable.

Type:

(inner) tabGroupLabels :Array.<String>

Source:
Type:
  • Array.<String>

(inner) tabGroupLabelsMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the tabGroupLabels property is editable.

Type:

(inner) tabId :String

Source:

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].

Type:
  • String

(inner) tabIdMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the tabId property is editable.

Type:

(inner) tabLabel :String

Source:

The label string associated with the tab.

Type:
  • String

(inner) tabLabelMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the tabLabel property is editable.

Type:

(inner) tabOrder :String

Source:
Type:
  • String

(inner) tabOrderMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the tabOrder property is editable.

Type:

(inner) tabType :String

Source:
Type:
  • String

(inner) tabTypeMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the tabType property is editable.

Type:

(inner) templateLocked :String

Source:

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

Type:
  • String

(inner) templateLockedMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the templateLocked property is editable.

Type:

(inner) templateRequired :String

Source:

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

Type:
  • String

(inner) templateRequiredMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the templateRequired property is editable.

Type:

(inner) tooltip :String

Source:
Type:
  • String

(inner) toolTipMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the toolTip property is editable.

Type:

(inner) underline :String

Source:

When set to true, the information in the tab is underlined.

Type:
  • String

(inner) underlineMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the underline property is editable.

Type:

(inner) value :String

Source:

The value to use when the item is selected.

Type:
  • String

(inner) valueMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the value property is editable.

Type:

(inner) width :String

Source:

Width of the tab in pixels.

Type:
  • String

(inner) widthMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the width property is editable.

Type:

(inner) xPosition :String

Source:

This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.

Type:
  • String

(inner) xPositionMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the xPosition property is editable.

Type:

(inner) yPosition :String

Source:

This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.

Type:
  • String

(inner) yPositionMetadata :module:model/PropertyMetadata

Source:

Metadata that indicates whether the yPosition property is editable.

Type:

Methods

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

Source:

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

Optional instance to populate.
Returns:

The populated List instance.

Type
module:model/List