List (docusign-esign-java 3.2.0 API)

java.lang.Object
- com.docusign.esign.model.List

```
public class List
extends Object
```
List

Constructor Summary

Constructors
Constructor and Description

List()

Constructors
Constructor and Description
`List()`

Method Summary

Methods
Modifier and Type	Method and Description
`List`	`addListItemsItem(ListItem listItemsItem)`
`List`	`addTabGroupLabelsItem(String tabGroupLabelsItem)`
`List`	`anchorCaseSensitive(String anchorCaseSensitive)`
`List`	`anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`List`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`
`List`	`anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`List`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`List`	`anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`List`	`anchorMatchWholeWord(String anchorMatchWholeWord)`
`List`	`anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`List`	`anchorString(String anchorString)`
`List`	`anchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`List`	`anchorTabProcessorVersion(String anchorTabProcessorVersion)`
`List`	`anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`List`	`anchorUnits(String anchorUnits)`
`List`	`anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`List`	`anchorXOffset(String anchorXOffset)`
`List`	`anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`List`	`anchorYOffset(String anchorYOffset)`
`List`	`anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`List`	`bold(String bold)`
`List`	`boldMetadata(PropertyMetadata boldMetadata)`
`List`	`conditionalParentLabel(String conditionalParentLabel)`
`List`	`conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`List`	`conditionalParentValue(String conditionalParentValue)`
`List`	`conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`List`	`customTabId(String customTabId)`
`List`	`customTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`List`	`documentId(String documentId)`
`List`	`documentIdMetadata(PropertyMetadata documentIdMetadata)`
`boolean`	`equals(Object o)`
`List`	`errorDetails(ErrorDetails errorDetails)`
`List`	`font(String font)`
`List`	`fontColor(String fontColor)`
`List`	`fontColorMetadata(PropertyMetadata fontColorMetadata)`
`List`	`fontMetadata(PropertyMetadata fontMetadata)`
`List`	`fontSize(String fontSize)`
`List`	`fontSizeMetadata(PropertyMetadata fontSizeMetadata)`
`List`	`formOrder(String formOrder)`
`List`	`formOrderMetadata(PropertyMetadata formOrderMetadata)`
`List`	`formPageLabel(String formPageLabel)`
`List`	`formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`List`	`formPageNumber(String formPageNumber)`
`List`	`formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`String`	`getAnchorCaseSensitive()` When set to true, the anchor string does not consider case when matching strings in the document.
`PropertyMetadata`	`getAnchorCaseSensitiveMetadata()` Get anchorCaseSensitiveMetadata
`String`	`getAnchorHorizontalAlignment()` Specifies the alignment of anchor tabs with anchor strings.
`PropertyMetadata`	`getAnchorHorizontalAlignmentMetadata()` Get anchorHorizontalAlignmentMetadata
`String`	`getAnchorIgnoreIfNotPresent()` When set to true, this tab is ignored if anchorString is not found in the document.
`PropertyMetadata`	`getAnchorIgnoreIfNotPresentMetadata()` Get anchorIgnoreIfNotPresentMetadata
`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.
`PropertyMetadata`	`getAnchorMatchWholeWordMetadata()` Get anchorMatchWholeWordMetadata
`String`	`getAnchorString()` Anchor text information for a radio button.
`PropertyMetadata`	`getAnchorStringMetadata()` Get anchorStringMetadata
`String`	`getAnchorTabProcessorVersion()`
`PropertyMetadata`	`getAnchorTabProcessorVersionMetadata()` Get anchorTabProcessorVersionMetadata
`String`	`getAnchorUnits()` Specifies units of the X and Y offset.
`PropertyMetadata`	`getAnchorUnitsMetadata()` Get anchorUnitsMetadata
`String`	`getAnchorXOffset()` Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorXOffsetMetadata()` Get anchorXOffsetMetadata
`String`	`getAnchorYOffset()` Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
`PropertyMetadata`	`getAnchorYOffsetMetadata()` Get anchorYOffsetMetadata
`String`	`getBold()` When set to true, the information in the tab is bold.
`PropertyMetadata`	`getBoldMetadata()` Get boldMetadata
`String`	`getConditionalParentLabel()` For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
`PropertyMetadata`	`getConditionalParentLabelMetadata()` Get conditionalParentLabelMetadata
`String`	`getConditionalParentValue()` For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`PropertyMetadata`	`getConditionalParentValueMetadata()` Get conditionalParentValueMetadata
`String`	`getCustomTabId()` The DocuSign generated custom tab ID for the custom tab to be applied.
`PropertyMetadata`	`getCustomTabIdMetadata()` Get customTabIdMetadata
`String`	`getDocumentId()` Specifies the document ID number that the tab is placed on.
`PropertyMetadata`	`getDocumentIdMetadata()` Get documentIdMetadata
`ErrorDetails`	`getErrorDetails()` Get errorDetails
`String`	`getFont()` The font to be used for the tab value.
`String`	`getFontColor()` The font color used for the information in the tab.
`PropertyMetadata`	`getFontColorMetadata()` Get fontColorMetadata
`PropertyMetadata`	`getFontMetadata()` Get fontMetadata
`String`	`getFontSize()` The font size used for the information in the tab.
`PropertyMetadata`	`getFontSizeMetadata()` Get fontSizeMetadata
`String`	`getFormOrder()`
`PropertyMetadata`	`getFormOrderMetadata()` Get formOrderMetadata
`String`	`getFormPageLabel()`
`PropertyMetadata`	`getFormPageLabelMetadata()` Get formPageLabelMetadata
`String`	`getFormPageNumber()`
`PropertyMetadata`	`getFormPageNumberMetadata()` Get formPageNumberMetadata
`String`	`getHeight()` Height of the tab in pixels.
`PropertyMetadata`	`getHeightMetadata()` Get heightMetadata
`String`	`getItalic()` When set to true, the information in the tab is italic.
`PropertyMetadata`	`getItalicMetadata()` Get italicMetadata
`List<ListItem>`	`getListItems()` The list of values that can be selected by senders.
`String`	`getListSelectedValue()`
`PropertyMetadata`	`getListSelectedValueMetadata()` Get listSelectedValueMetadata
`LocalePolicyTab`	`getLocalePolicy()` Get localePolicy
`String`	`getLocked()` When set to true, the signer cannot change the data of the custom tab.
`PropertyMetadata`	`getLockedMetadata()` Get lockedMetadata
`MergeField`	`getMergeField()` Get mergeField
`String`	`getMergeFieldXml()`
`String`	`getPageNumber()` Specifies the page number on which the tab is located.
`PropertyMetadata`	`getPageNumberMetadata()` Get pageNumberMetadata
`String`	`getRecipientId()` Unique for the recipient.
`String`	`getRecipientIdGuid()`
`PropertyMetadata`	`getRecipientIdGuidMetadata()` Get recipientIdGuidMetadata
`PropertyMetadata`	`getRecipientIdMetadata()` Get recipientIdMetadata
`String`	`getRequireAll()` When set to true and shared is true, information must be entered in this field to complete the envelope.
`PropertyMetadata`	`getRequireAllMetadata()` Get requireAllMetadata
`String`	`getRequired()` When set to true, the signer is required to fill out this tab
`PropertyMetadata`	`getRequiredMetadata()` Get requiredMetadata
`String`	`getRequireInitialOnSharedChange()` Optional element for field markup.
`PropertyMetadata`	`getRequireInitialOnSharedChangeMetadata()` Get requireInitialOnSharedChangeMetadata
`String`	`getSenderRequired()` When set to true, the sender must populate the tab before an envelope can be sent using the template.
`PropertyMetadata`	`getSenderRequiredMetadata()` Get senderRequiredMetadata
`String`	`getShared()` When set to true, this custom tab is shared.
`PropertyMetadata`	`getSharedMetadata()` Get sharedMetadata
`String`	`getStatus()` Indicates the envelope status.
`PropertyMetadata`	`getStatusMetadata()` Get statusMetadata
`List<String>`	`getTabGroupLabels()`
`PropertyMetadata`	`getTabGroupLabelsMetadata()` Get tabGroupLabelsMetadata
`String`	`getTabId()` The unique identifier for the tab.
`PropertyMetadata`	`getTabIdMetadata()` Get tabIdMetadata
`String`	`getTabLabel()` The label string associated with the tab.
`PropertyMetadata`	`getTabLabelMetadata()` Get tabLabelMetadata
`String`	`getTabOrder()`
`PropertyMetadata`	`getTabOrderMetadata()` Get tabOrderMetadata
`String`	`getTabType()`
`PropertyMetadata`	`getTabTypeMetadata()` Get tabTypeMetadata
`String`	`getTemplateLocked()` When set to true, the sender cannot change any attributes of the recipient.
`PropertyMetadata`	`getTemplateLockedMetadata()` Get templateLockedMetadata
`String`	`getTemplateRequired()` When set to true, the sender may not remove the recipient.
`PropertyMetadata`	`getTemplateRequiredMetadata()` Get templateRequiredMetadata
`String`	`getTooltip()`
`PropertyMetadata`	`getToolTipMetadata()` Get toolTipMetadata
`String`	`getUnderline()` When set to true, the information in the tab is underlined.
`PropertyMetadata`	`getUnderlineMetadata()` Get underlineMetadata
`String`	`getValue()` The value to use when the item is selected.
`PropertyMetadata`	`getValueMetadata()` Get valueMetadata
`String`	`getWidth()` Width of the tab in pixels.
`PropertyMetadata`	`getWidthMetadata()` Get widthMetadata
`String`	`getXPosition()` This indicates the horizontal offset of the object on the page.
`PropertyMetadata`	`getXPositionMetadata()` Get xPositionMetadata
`String`	`getYPosition()` This indicates the vertical offset of the object on the page.
`PropertyMetadata`	`getYPositionMetadata()` Get yPositionMetadata
`int`	`hashCode()`
`List`	`height(String height)`
`List`	`heightMetadata(PropertyMetadata heightMetadata)`
`List`	`italic(String italic)`
`List`	`italicMetadata(PropertyMetadata italicMetadata)`
`List`	`listItems(List<ListItem> listItems)`
`List`	`listSelectedValue(String listSelectedValue)`
`List`	`listSelectedValueMetadata(PropertyMetadata listSelectedValueMetadata)`
`List`	`localePolicy(LocalePolicyTab localePolicy)`
`List`	`locked(String locked)`
`List`	`lockedMetadata(PropertyMetadata lockedMetadata)`
`List`	`mergeField(MergeField mergeField)`
`List`	`mergeFieldXml(String mergeFieldXml)`
`List`	`pageNumber(String pageNumber)`
`List`	`pageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`List`	`recipientId(String recipientId)`
`List`	`recipientIdGuid(String recipientIdGuid)`
`List`	`recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`List`	`recipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`List`	`requireAll(String requireAll)`
`List`	`requireAllMetadata(PropertyMetadata requireAllMetadata)`
`List`	`required(String required)`
`List`	`requiredMetadata(PropertyMetadata requiredMetadata)`
`List`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)`
`List`	`requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`
`List`	`senderRequired(String senderRequired)`
`List`	`senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`
`void`	`setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`
`void`	`setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`
`void`	`setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`
`void`	`setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`
`void`	`setAnchorString(String anchorString)`
`void`	`setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)`
`void`	`setAnchorTabProcessorVersion(String anchorTabProcessorVersion)`
`void`	`setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`
`void`	`setAnchorUnits(String anchorUnits)`
`void`	`setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`
`void`	`setAnchorXOffset(String anchorXOffset)`
`void`	`setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`
`void`	`setAnchorYOffset(String anchorYOffset)`
`void`	`setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`
`void`	`setBold(String bold)`
`void`	`setBoldMetadata(PropertyMetadata boldMetadata)`
`void`	`setConditionalParentLabel(String conditionalParentLabel)`
`void`	`setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`
`void`	`setConditionalParentValue(String conditionalParentValue)`
`void`	`setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`
`void`	`setCustomTabId(String customTabId)`
`void`	`setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)`
`void`	`setDocumentId(String documentId)`
`void`	`setDocumentIdMetadata(PropertyMetadata documentIdMetadata)`
`void`	`setErrorDetails(ErrorDetails errorDetails)`
`void`	`setFont(String font)`
`void`	`setFontColor(String fontColor)`
`void`	`setFontColorMetadata(PropertyMetadata fontColorMetadata)`
`void`	`setFontMetadata(PropertyMetadata fontMetadata)`
`void`	`setFontSize(String fontSize)`
`void`	`setFontSizeMetadata(PropertyMetadata fontSizeMetadata)`
`void`	`setFormOrder(String formOrder)`
`void`	`setFormOrderMetadata(PropertyMetadata formOrderMetadata)`
`void`	`setFormPageLabel(String formPageLabel)`
`void`	`setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`
`void`	`setFormPageNumber(String formPageNumber)`
`void`	`setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`
`void`	`setHeight(String height)`
`void`	`setHeightMetadata(PropertyMetadata heightMetadata)`
`void`	`setItalic(String italic)`
`void`	`setItalicMetadata(PropertyMetadata italicMetadata)`
`void`	`setListItems(List<ListItem> listItems)`
`void`	`setListSelectedValue(String listSelectedValue)`
`void`	`setListSelectedValueMetadata(PropertyMetadata listSelectedValueMetadata)`
`void`	`setLocalePolicy(LocalePolicyTab localePolicy)`
`void`	`setLocked(String locked)`
`void`	`setLockedMetadata(PropertyMetadata lockedMetadata)`
`void`	`setMergeField(MergeField mergeField)`
`void`	`setMergeFieldXml(String mergeFieldXml)`
`void`	`setPageNumber(String pageNumber)`
`void`	`setPageNumberMetadata(PropertyMetadata pageNumberMetadata)`
`void`	`setRecipientId(String recipientId)`
`void`	`setRecipientIdGuid(String recipientIdGuid)`
`void`	`setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`
`void`	`setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)`
`void`	`setRequireAll(String requireAll)`
`void`	`setRequireAllMetadata(PropertyMetadata requireAllMetadata)`
`void`	`setRequired(String required)`
`void`	`setRequiredMetadata(PropertyMetadata requiredMetadata)`
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`
`void`	`setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`
`void`	`setSenderRequired(String senderRequired)`
`void`	`setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`
`void`	`setShared(String shared)`
`void`	`setSharedMetadata(PropertyMetadata sharedMetadata)`
`void`	`setStatus(String status)`
`void`	`setStatusMetadata(PropertyMetadata statusMetadata)`
`void`	`setTabGroupLabels(List<String> tabGroupLabels)`
`void`	`setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`void`	`setTabId(String tabId)`
`void`	`setTabIdMetadata(PropertyMetadata tabIdMetadata)`
`void`	`setTabLabel(String tabLabel)`
`void`	`setTabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`void`	`setTabOrder(String tabOrder)`
`void`	`setTabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`void`	`setTabType(String tabType)`
`void`	`setTabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`void`	`setTemplateLocked(String templateLocked)`
`void`	`setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`void`	`setTemplateRequired(String templateRequired)`
`void`	`setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`void`	`setTooltip(String tooltip)`
`void`	`setToolTipMetadata(PropertyMetadata toolTipMetadata)`
`void`	`setUnderline(String underline)`
`void`	`setUnderlineMetadata(PropertyMetadata underlineMetadata)`
`void`	`setValue(String value)`
`void`	`setValueMetadata(PropertyMetadata valueMetadata)`
`void`	`setWidth(String width)`
`void`	`setWidthMetadata(PropertyMetadata widthMetadata)`
`void`	`setXPosition(String xPosition)`
`void`	`setXPositionMetadata(PropertyMetadata xPositionMetadata)`
`void`	`setYPosition(String yPosition)`
`void`	`setYPositionMetadata(PropertyMetadata yPositionMetadata)`
`List`	`shared(String shared)`
`List`	`sharedMetadata(PropertyMetadata sharedMetadata)`
`List`	`status(String status)`
`List`	`statusMetadata(PropertyMetadata statusMetadata)`
`List`	`tabGroupLabels(List<String> tabGroupLabels)`
`List`	`tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`
`List`	`tabId(String tabId)`
`List`	`tabIdMetadata(PropertyMetadata tabIdMetadata)`
`List`	`tabLabel(String tabLabel)`
`List`	`tabLabelMetadata(PropertyMetadata tabLabelMetadata)`
`List`	`tabOrder(String tabOrder)`
`List`	`tabOrderMetadata(PropertyMetadata tabOrderMetadata)`
`List`	`tabType(String tabType)`
`List`	`tabTypeMetadata(PropertyMetadata tabTypeMetadata)`
`List`	`templateLocked(String templateLocked)`
`List`	`templateLockedMetadata(PropertyMetadata templateLockedMetadata)`
`List`	`templateRequired(String templateRequired)`
`List`	`templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`
`List`	`tooltip(String tooltip)`
`List`	`toolTipMetadata(PropertyMetadata toolTipMetadata)`
`String`	`toString()`
`List`	`underline(String underline)`
`List`	`underlineMetadata(PropertyMetadata underlineMetadata)`
`List`	`value(String value)`
`List`	`valueMetadata(PropertyMetadata valueMetadata)`
`List`	`width(String width)`
`List`	`widthMetadata(PropertyMetadata widthMetadata)`
`List`	`xPosition(String xPosition)`
`List`	`xPositionMetadata(PropertyMetadata xPositionMetadata)`
`List`	`yPosition(String yPosition)`
`List`	`yPositionMetadata(PropertyMetadata yPositionMetadata)`

Methods inherited from class java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail
- List
```
public List()
```

Method Detail

anchorCaseSensitive

public List anchorCaseSensitive(String anchorCaseSensitive)

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)

anchorCaseSensitiveMetadata

public List anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

getAnchorCaseSensitiveMetadata
```
public PropertyMetadata getAnchorCaseSensitiveMetadata()
```
Get anchorCaseSensitiveMetadata

Returns:
anchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)

anchorHorizontalAlignment

public List anchorHorizontalAlignment(String anchorHorizontalAlignment)

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)

anchorHorizontalAlignmentMetadata

public List anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

getAnchorHorizontalAlignmentMetadata
```
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
```
Get anchorHorizontalAlignmentMetadata

Returns:
anchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)

anchorIgnoreIfNotPresent

public List anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)

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)

anchorIgnoreIfNotPresentMetadata

public List anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

getAnchorIgnoreIfNotPresentMetadata
```
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
```
Get anchorIgnoreIfNotPresentMetadata

Returns:
anchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)

anchorMatchWholeWord

public List anchorMatchWholeWord(String anchorMatchWholeWord)

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)

anchorMatchWholeWordMetadata

public List anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

getAnchorMatchWholeWordMetadata
```
public PropertyMetadata getAnchorMatchWholeWordMetadata()
```
Get anchorMatchWholeWordMetadata

Returns:
anchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)

anchorString

public List anchorString(String anchorString)

getAnchorString
```
public String getAnchorString()
```
Anchor text information for a radio button.

Returns:
anchorString

setAnchorString

public void setAnchorString(String anchorString)

anchorStringMetadata

public List anchorStringMetadata(PropertyMetadata anchorStringMetadata)

getAnchorStringMetadata
```
public PropertyMetadata getAnchorStringMetadata()
```
Get anchorStringMetadata

Returns:
anchorStringMetadata

setAnchorStringMetadata

public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)

anchorTabProcessorVersion

public List anchorTabProcessorVersion(String anchorTabProcessorVersion)

getAnchorTabProcessorVersion
```
public String getAnchorTabProcessorVersion()
```
Returns:
anchorTabProcessorVersion

setAnchorTabProcessorVersion

public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)

anchorTabProcessorVersionMetadata

public List anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

getAnchorTabProcessorVersionMetadata
```
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
```
Get anchorTabProcessorVersionMetadata

Returns:
anchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)

anchorUnits

public List anchorUnits(String anchorUnits)

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)

anchorUnitsMetadata

public List anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

getAnchorUnitsMetadata
```
public PropertyMetadata getAnchorUnitsMetadata()
```
Get anchorUnitsMetadata

Returns:
anchorUnitsMetadata

setAnchorUnitsMetadata

public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)

anchorXOffset

public List anchorXOffset(String anchorXOffset)

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)

anchorXOffsetMetadata

public List anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

getAnchorXOffsetMetadata
```
public PropertyMetadata getAnchorXOffsetMetadata()
```
Get anchorXOffsetMetadata

Returns:
anchorXOffsetMetadata

setAnchorXOffsetMetadata

public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)

anchorYOffset

public List anchorYOffset(String anchorYOffset)

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)

anchorYOffsetMetadata

public List anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

getAnchorYOffsetMetadata
```
public PropertyMetadata getAnchorYOffsetMetadata()
```
Get anchorYOffsetMetadata

Returns:
anchorYOffsetMetadata

setAnchorYOffsetMetadata

public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)

bold
```
public List bold(String bold)
```

getBold
```
public String getBold()
```
When set to **true**, the information in the tab is bold.

Returns:
bold

setBold
```
public void setBold(String bold)
```

boldMetadata

public List boldMetadata(PropertyMetadata boldMetadata)

getBoldMetadata
```
public PropertyMetadata getBoldMetadata()
```
Get boldMetadata

Returns:
boldMetadata

setBoldMetadata

public void setBoldMetadata(PropertyMetadata boldMetadata)

conditionalParentLabel

public List conditionalParentLabel(String conditionalParentLabel)

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)

conditionalParentLabelMetadata

public List conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

getConditionalParentLabelMetadata
```
public PropertyMetadata getConditionalParentLabelMetadata()
```
Get conditionalParentLabelMetadata

Returns:
conditionalParentLabelMetadata

setConditionalParentLabelMetadata

public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)

conditionalParentValue

public List conditionalParentValue(String conditionalParentValue)

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)

conditionalParentValueMetadata

public List conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

getConditionalParentValueMetadata
```
public PropertyMetadata getConditionalParentValueMetadata()
```
Get conditionalParentValueMetadata

Returns:
conditionalParentValueMetadata

setConditionalParentValueMetadata

public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)

customTabId

public List customTabId(String customTabId)

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)

customTabIdMetadata

public List customTabIdMetadata(PropertyMetadata customTabIdMetadata)

getCustomTabIdMetadata
```
public PropertyMetadata getCustomTabIdMetadata()
```
Get customTabIdMetadata

Returns:
customTabIdMetadata

setCustomTabIdMetadata

public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)

documentId

public List documentId(String documentId)

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)

documentIdMetadata

public List documentIdMetadata(PropertyMetadata documentIdMetadata)

getDocumentIdMetadata
```
public PropertyMetadata getDocumentIdMetadata()
```
Get documentIdMetadata

Returns:
documentIdMetadata

setDocumentIdMetadata

public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)

errorDetails

public List errorDetails(ErrorDetails errorDetails)

getErrorDetails
```
public ErrorDetails getErrorDetails()
```
Get errorDetails

Returns:
errorDetails

setErrorDetails

public void setErrorDetails(ErrorDetails errorDetails)

font
```
public List font(String font)
```

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)
```

fontColor

public List fontColor(String fontColor)

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)

fontColorMetadata

public List fontColorMetadata(PropertyMetadata fontColorMetadata)

getFontColorMetadata
```
public PropertyMetadata getFontColorMetadata()
```
Get fontColorMetadata

Returns:
fontColorMetadata

setFontColorMetadata

public void setFontColorMetadata(PropertyMetadata fontColorMetadata)

fontMetadata

public List fontMetadata(PropertyMetadata fontMetadata)

getFontMetadata
```
public PropertyMetadata getFontMetadata()
```
Get fontMetadata

Returns:
fontMetadata

setFontMetadata

public void setFontMetadata(PropertyMetadata fontMetadata)

setFontSize

public void setFontSize(String fontSize)

fontSizeMetadata

public List fontSizeMetadata(PropertyMetadata fontSizeMetadata)

getFontSizeMetadata
```
public PropertyMetadata getFontSizeMetadata()
```
Get fontSizeMetadata

Returns:
fontSizeMetadata

setFontSizeMetadata

public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)

formOrder

public List formOrder(String formOrder)

getFormOrder
```
public String getFormOrder()
```
Returns:
formOrder

setFormOrder

public void setFormOrder(String formOrder)

formOrderMetadata

public List formOrderMetadata(PropertyMetadata formOrderMetadata)

getFormOrderMetadata
```
public PropertyMetadata getFormOrderMetadata()
```
Get formOrderMetadata

Returns:
formOrderMetadata

setFormOrderMetadata

public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)

formPageLabel

public List formPageLabel(String formPageLabel)

getFormPageLabel
```
public String getFormPageLabel()
```
Returns:
formPageLabel

setFormPageLabel

public void setFormPageLabel(String formPageLabel)

formPageLabelMetadata

public List formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

getFormPageLabelMetadata
```
public PropertyMetadata getFormPageLabelMetadata()
```
Get formPageLabelMetadata

Returns:
formPageLabelMetadata

setFormPageLabelMetadata

public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)

formPageNumber

public List formPageNumber(String formPageNumber)

getFormPageNumber
```
public String getFormPageNumber()
```
Returns:
formPageNumber

setFormPageNumber

public void setFormPageNumber(String formPageNumber)

formPageNumberMetadata

public List formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

getFormPageNumberMetadata
```
public PropertyMetadata getFormPageNumberMetadata()
```
Get formPageNumberMetadata

Returns:
formPageNumberMetadata

setFormPageNumberMetadata

public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)

height
```
public List height(String height)
```

getHeight
```
public String getHeight()
```
Height of the tab in pixels.

Returns:
height

setHeight
```
public void setHeight(String height)
```

heightMetadata

public List heightMetadata(PropertyMetadata heightMetadata)

getHeightMetadata
```
public PropertyMetadata getHeightMetadata()
```
Get heightMetadata

Returns:
heightMetadata

setHeightMetadata

public void setHeightMetadata(PropertyMetadata heightMetadata)

italic
```
public List italic(String italic)
```

getItalic
```
public String getItalic()
```
When set to **true**, the information in the tab is italic.

Returns:
italic

setItalic
```
public void setItalic(String italic)
```

italicMetadata

public List italicMetadata(PropertyMetadata italicMetadata)

getItalicMetadata
```
public PropertyMetadata getItalicMetadata()
```
Get italicMetadata

Returns:
italicMetadata

setItalicMetadata

public void setItalicMetadata(PropertyMetadata italicMetadata)

listItems

public List listItems(List<ListItem> listItems)

addListItemsItem

public List addListItemsItem(ListItem listItemsItem)

getListItems
```
public List<ListItem> getListItems()
```
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.

Returns:
listItems

setListItems

public void setListItems(List<ListItem> listItems)

listSelectedValue

public List listSelectedValue(String listSelectedValue)

getListSelectedValue
```
public String getListSelectedValue()
```
Returns:
listSelectedValue

setListSelectedValue

public void setListSelectedValue(String listSelectedValue)

listSelectedValueMetadata

public List listSelectedValueMetadata(PropertyMetadata listSelectedValueMetadata)

getListSelectedValueMetadata
```
public PropertyMetadata getListSelectedValueMetadata()
```
Get listSelectedValueMetadata

Returns:
listSelectedValueMetadata

setListSelectedValueMetadata

public void setListSelectedValueMetadata(PropertyMetadata listSelectedValueMetadata)

localePolicy

public List localePolicy(LocalePolicyTab localePolicy)

getLocalePolicy
```
public LocalePolicyTab getLocalePolicy()
```
Get localePolicy

Returns:
localePolicy

setLocalePolicy

public void setLocalePolicy(LocalePolicyTab localePolicy)

locked
```
public List locked(String locked)
```

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)
```

lockedMetadata

public List lockedMetadata(PropertyMetadata lockedMetadata)

getLockedMetadata
```
public PropertyMetadata getLockedMetadata()
```
Get lockedMetadata

Returns:
lockedMetadata

setLockedMetadata

public void setLockedMetadata(PropertyMetadata lockedMetadata)

mergeField

public List mergeField(MergeField mergeField)

getMergeField
```
public MergeField getMergeField()
```
Get mergeField

Returns:
mergeField

setMergeField

public void setMergeField(MergeField mergeField)

mergeFieldXml

public List mergeFieldXml(String mergeFieldXml)

getMergeFieldXml
```
public String getMergeFieldXml()
```
Returns:
mergeFieldXml

setMergeFieldXml

public void setMergeFieldXml(String mergeFieldXml)

pageNumber

public List pageNumber(String pageNumber)

getPageNumber
```
public String getPageNumber()
```
Specifies the page number on which the tab is located.

Returns:
pageNumber

setPageNumber

public void setPageNumber(String pageNumber)

pageNumberMetadata

public List pageNumberMetadata(PropertyMetadata pageNumberMetadata)

getPageNumberMetadata
```
public PropertyMetadata getPageNumberMetadata()
```
Get pageNumberMetadata

Returns:
pageNumberMetadata

setPageNumberMetadata

public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)

recipientId

public List recipientId(String recipientId)

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)

recipientIdGuid

public List recipientIdGuid(String recipientIdGuid)

getRecipientIdGuid
```
public String getRecipientIdGuid()
```
Returns:
recipientIdGuid

setRecipientIdGuid

public void setRecipientIdGuid(String recipientIdGuid)

recipientIdGuidMetadata

public List recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

getRecipientIdGuidMetadata
```
public PropertyMetadata getRecipientIdGuidMetadata()
```
Get recipientIdGuidMetadata

Returns:
recipientIdGuidMetadata

setRecipientIdGuidMetadata

public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)

recipientIdMetadata

public List recipientIdMetadata(PropertyMetadata recipientIdMetadata)

getRecipientIdMetadata
```
public PropertyMetadata getRecipientIdMetadata()
```
Get recipientIdMetadata

Returns:
recipientIdMetadata

setRecipientIdMetadata

public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)

requireAll

public List requireAll(String requireAll)

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)

requireAllMetadata

public List requireAllMetadata(PropertyMetadata requireAllMetadata)

getRequireAllMetadata
```
public PropertyMetadata getRequireAllMetadata()
```
Get requireAllMetadata

Returns:
requireAllMetadata

setRequireAllMetadata

public void setRequireAllMetadata(PropertyMetadata requireAllMetadata)

required

public List required(String required)

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)

requiredMetadata

public List requiredMetadata(PropertyMetadata requiredMetadata)

getRequiredMetadata
```
public PropertyMetadata getRequiredMetadata()
```
Get requiredMetadata

Returns:
requiredMetadata

setRequiredMetadata

public void setRequiredMetadata(PropertyMetadata requiredMetadata)

requireInitialOnSharedChange

public List requireInitialOnSharedChange(String requireInitialOnSharedChange)

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)

requireInitialOnSharedChangeMetadata

public List requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

getRequireInitialOnSharedChangeMetadata
```
public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
```
Get requireInitialOnSharedChangeMetadata

Returns:
requireInitialOnSharedChangeMetadata

setRequireInitialOnSharedChangeMetadata

public void setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)

senderRequired

public List senderRequired(String senderRequired)

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)

senderRequiredMetadata

public List senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)

getSenderRequiredMetadata
```
public PropertyMetadata getSenderRequiredMetadata()
```
Get senderRequiredMetadata

Returns:
senderRequiredMetadata

setSenderRequiredMetadata

public void setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)

shared
```
public List shared(String shared)
```

getShared
```
public String getShared()
```
When set to **true**, this custom tab is shared.

Returns:
shared

setShared
```
public void setShared(String shared)
```

sharedMetadata

public List sharedMetadata(PropertyMetadata sharedMetadata)

getSharedMetadata
```
public PropertyMetadata getSharedMetadata()
```
Get sharedMetadata

Returns:
sharedMetadata

setSharedMetadata

public void setSharedMetadata(PropertyMetadata sharedMetadata)

status
```
public List status(String status)
```

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)
```

statusMetadata

public List statusMetadata(PropertyMetadata statusMetadata)

getStatusMetadata
```
public PropertyMetadata getStatusMetadata()
```
Get statusMetadata

Returns:
statusMetadata

setStatusMetadata

public void setStatusMetadata(PropertyMetadata statusMetadata)

tabGroupLabels

public List tabGroupLabels(List<String> tabGroupLabels)

addTabGroupLabelsItem

public List addTabGroupLabelsItem(String tabGroupLabelsItem)

getTabGroupLabels

public List<String> getTabGroupLabels()

Returns:: tabGroupLabels

setTabGroupLabels

public void setTabGroupLabels(List<String> tabGroupLabels)

tabGroupLabelsMetadata

public List tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

getTabGroupLabelsMetadata
```
public PropertyMetadata getTabGroupLabelsMetadata()
```
Get tabGroupLabelsMetadata

Returns:
tabGroupLabelsMetadata

setTabGroupLabelsMetadata

public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)

tabId
```
public List tabId(String tabId)
```

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)
```

tabIdMetadata

public List tabIdMetadata(PropertyMetadata tabIdMetadata)

getTabIdMetadata
```
public PropertyMetadata getTabIdMetadata()
```
Get tabIdMetadata

Returns:
tabIdMetadata

setTabIdMetadata

public void setTabIdMetadata(PropertyMetadata tabIdMetadata)

tabLabel

public List tabLabel(String tabLabel)

getTabLabel
```
public String getTabLabel()
```
The label string associated with the tab.

Returns:
tabLabel

setTabLabel

public void setTabLabel(String tabLabel)

tabLabelMetadata

public List tabLabelMetadata(PropertyMetadata tabLabelMetadata)

getTabLabelMetadata
```
public PropertyMetadata getTabLabelMetadata()
```
Get tabLabelMetadata

Returns:
tabLabelMetadata

setTabLabelMetadata

public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)

tabOrder

public List tabOrder(String tabOrder)

getTabOrder
```
public String getTabOrder()
```
Returns:
tabOrder

setTabOrder

public void setTabOrder(String tabOrder)

tabOrderMetadata

public List tabOrderMetadata(PropertyMetadata tabOrderMetadata)

getTabOrderMetadata
```
public PropertyMetadata getTabOrderMetadata()
```
Get tabOrderMetadata

Returns:
tabOrderMetadata

setTabOrderMetadata

public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)

tabType
```
public List tabType(String tabType)
```

getTabType
```
public String getTabType()
```
Returns:
tabType

setTabType

public void setTabType(String tabType)

tabTypeMetadata

public List tabTypeMetadata(PropertyMetadata tabTypeMetadata)

getTabTypeMetadata
```
public PropertyMetadata getTabTypeMetadata()
```
Get tabTypeMetadata

Returns:
tabTypeMetadata

setTabTypeMetadata

public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)

templateLocked

public List templateLocked(String templateLocked)

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)

templateLockedMetadata

public List templateLockedMetadata(PropertyMetadata templateLockedMetadata)

getTemplateLockedMetadata
```
public PropertyMetadata getTemplateLockedMetadata()
```
Get templateLockedMetadata

Returns:
templateLockedMetadata

setTemplateLockedMetadata

public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)

templateRequired

public List templateRequired(String templateRequired)

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)

templateRequiredMetadata

public List templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

getTemplateRequiredMetadata
```
public PropertyMetadata getTemplateRequiredMetadata()
```
Get templateRequiredMetadata

Returns:
templateRequiredMetadata

setTemplateRequiredMetadata

public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)

tooltip
```
public List tooltip(String tooltip)
```

getTooltip
```
public String getTooltip()
```
Returns:
tooltip

setTooltip

public void setTooltip(String tooltip)

toolTipMetadata

public List toolTipMetadata(PropertyMetadata toolTipMetadata)

getToolTipMetadata
```
public PropertyMetadata getToolTipMetadata()
```
Get toolTipMetadata

Returns:
toolTipMetadata

setToolTipMetadata

public void setToolTipMetadata(PropertyMetadata toolTipMetadata)

underline

public List underline(String underline)

getUnderline
```
public String getUnderline()
```
When set to **true**, the information in the tab is underlined.

Returns:
underline

setUnderline

public void setUnderline(String underline)

underlineMetadata

public List underlineMetadata(PropertyMetadata underlineMetadata)

getUnderlineMetadata
```
public PropertyMetadata getUnderlineMetadata()
```
Get underlineMetadata

Returns:
underlineMetadata

setUnderlineMetadata

public void setUnderlineMetadata(PropertyMetadata underlineMetadata)

value
```
public List value(String value)
```

getValue
```
public String getValue()
```
The value to use when the item is selected.

Returns:
value

setValue
```
public void setValue(String value)
```

valueMetadata

public List valueMetadata(PropertyMetadata valueMetadata)

getValueMetadata
```
public PropertyMetadata getValueMetadata()
```
Get valueMetadata

Returns:
valueMetadata

setValueMetadata

public void setValueMetadata(PropertyMetadata valueMetadata)

width
```
public List width(String width)
```

getWidth
```
public String getWidth()
```
Width of the tab in pixels.

Returns:
width

setWidth
```
public void setWidth(String width)
```

widthMetadata

public List widthMetadata(PropertyMetadata widthMetadata)

getWidthMetadata
```
public PropertyMetadata getWidthMetadata()
```
Get widthMetadata

Returns:
widthMetadata

setWidthMetadata

public void setWidthMetadata(PropertyMetadata widthMetadata)

xPosition

public List xPosition(String xPosition)

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)

xPositionMetadata

public List xPositionMetadata(PropertyMetadata xPositionMetadata)

getXPositionMetadata
```
public PropertyMetadata getXPositionMetadata()
```
Get xPositionMetadata

Returns:
xPositionMetadata

setXPositionMetadata

public void setXPositionMetadata(PropertyMetadata xPositionMetadata)

yPosition

public List yPosition(String yPosition)

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)

yPositionMetadata

public List yPositionMetadata(PropertyMetadata yPositionMetadata)

getYPositionMetadata
```
public PropertyMetadata getYPositionMetadata()
```
Get yPositionMetadata

Returns:
yPositionMetadata

setYPositionMetadata

public void setYPositionMetadata(PropertyMetadata yPositionMetadata)

equals
```
public boolean equals(Object o)
```
Overrides:

equals in class Object

hashCode
```
public int hashCode()
```
Overrides:

hashCode in class Object

toString
```
public String toString()
```
Overrides:

toString in class Object

Class List

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

List

Method Detail

anchorCaseSensitive

getAnchorCaseSensitive

setAnchorCaseSensitive

anchorCaseSensitiveMetadata

getAnchorCaseSensitiveMetadata

setAnchorCaseSensitiveMetadata

anchorHorizontalAlignment

getAnchorHorizontalAlignment

setAnchorHorizontalAlignment

anchorHorizontalAlignmentMetadata

getAnchorHorizontalAlignmentMetadata

setAnchorHorizontalAlignmentMetadata

anchorIgnoreIfNotPresent

getAnchorIgnoreIfNotPresent

setAnchorIgnoreIfNotPresent

anchorIgnoreIfNotPresentMetadata

getAnchorIgnoreIfNotPresentMetadata

setAnchorIgnoreIfNotPresentMetadata

anchorMatchWholeWord

getAnchorMatchWholeWord

setAnchorMatchWholeWord

anchorMatchWholeWordMetadata

getAnchorMatchWholeWordMetadata

setAnchorMatchWholeWordMetadata

anchorString

getAnchorString

setAnchorString

anchorStringMetadata

getAnchorStringMetadata

setAnchorStringMetadata

anchorTabProcessorVersion

getAnchorTabProcessorVersion

setAnchorTabProcessorVersion

anchorTabProcessorVersionMetadata

getAnchorTabProcessorVersionMetadata

setAnchorTabProcessorVersionMetadata

anchorUnits

getAnchorUnits

setAnchorUnits

anchorUnitsMetadata

getAnchorUnitsMetadata

setAnchorUnitsMetadata

anchorXOffset

getAnchorXOffset

setAnchorXOffset

anchorXOffsetMetadata

getAnchorXOffsetMetadata

setAnchorXOffsetMetadata

anchorYOffset

getAnchorYOffset

setAnchorYOffset

anchorYOffsetMetadata

getAnchorYOffsetMetadata

setAnchorYOffsetMetadata

bold

getBold

setBold

boldMetadata

getBoldMetadata

setBoldMetadata

conditionalParentLabel

getConditionalParentLabel

setConditionalParentLabel

conditionalParentLabelMetadata

getConditionalParentLabelMetadata

setConditionalParentLabelMetadata

conditionalParentValue

getConditionalParentValue

setConditionalParentValue

conditionalParentValueMetadata

getConditionalParentValueMetadata

setConditionalParentValueMetadata

customTabId