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

All Implemented Interfaces:

Serializable
```
public class Ssn
extends Object
implements Serializable
```
A one-line field that allows the recipient to enter a Social Security Number. The 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. .

See Also:

Serialized Form

Constructor Summary

Constructors
Constructor Description

Ssn()

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`Ssn`	`addTabGroupLabelsItem(String tabGroupLabelsItem)`	addTabGroupLabelsItem.
`Ssn`	`anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)`	anchorAllowWhiteSpaceInCharacters.
`Ssn`	`anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)`	anchorAllowWhiteSpaceInCharactersMetadata.
`Ssn`	`anchorCaseSensitive(String anchorCaseSensitive)`	anchorCaseSensitive.
`Ssn`	`anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`	anchorCaseSensitiveMetadata.
`Ssn`	`anchorHorizontalAlignment(String anchorHorizontalAlignment)`	anchorHorizontalAlignment.
`Ssn`	`anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`	anchorHorizontalAlignmentMetadata.
`Ssn`	`anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	anchorIgnoreIfNotPresent.
`Ssn`	`anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`	anchorIgnoreIfNotPresentMetadata.
`Ssn`	`anchorMatchWholeWord(String anchorMatchWholeWord)`	anchorMatchWholeWord.
`Ssn`	`anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`	anchorMatchWholeWordMetadata.
`Ssn`	`anchorString(String anchorString)`	anchorString.
`Ssn`	`anchorStringMetadata(PropertyMetadata anchorStringMetadata)`	anchorStringMetadata.
`Ssn`	`anchorTabProcessorVersion(String anchorTabProcessorVersion)`	anchorTabProcessorVersion.
`Ssn`	`anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`	anchorTabProcessorVersionMetadata.
`Ssn`	`anchorUnits(String anchorUnits)`	anchorUnits.
`Ssn`	`anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`	anchorUnitsMetadata.
`Ssn`	`anchorXOffset(String anchorXOffset)`	anchorXOffset.
`Ssn`	`anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`	anchorXOffsetMetadata.
`Ssn`	`anchorYOffset(String anchorYOffset)`	anchorYOffset.
`Ssn`	`anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`	anchorYOffsetMetadata.
`Ssn`	`bold(String bold)`	bold.
`Ssn`	`boldMetadata(PropertyMetadata boldMetadata)`	boldMetadata.
`Ssn`	`caption(String caption)`	caption.
`Ssn`	`captionMetadata(PropertyMetadata captionMetadata)`	captionMetadata.
`Ssn`	`concealValueOnDocument(String concealValueOnDocument)`	concealValueOnDocument.
`Ssn`	`concealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)`	concealValueOnDocumentMetadata.
`Ssn`	`conditionalParentLabel(String conditionalParentLabel)`	conditionalParentLabel.
`Ssn`	`conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`	conditionalParentLabelMetadata.
`Ssn`	`conditionalParentValue(String conditionalParentValue)`	conditionalParentValue.
`Ssn`	`conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`	conditionalParentValueMetadata.
`Ssn`	`customTabId(String customTabId)`	customTabId.
`Ssn`	`customTabIdMetadata(PropertyMetadata customTabIdMetadata)`	customTabIdMetadata.
`Ssn`	`disableAutoSize(String disableAutoSize)`	disableAutoSize.
`Ssn`	`disableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)`	disableAutoSizeMetadata.
`Ssn`	`documentId(String documentId)`	documentId.
`Ssn`	`documentIdMetadata(PropertyMetadata documentIdMetadata)`	documentIdMetadata.
`boolean`	`equals(Object o)`	Compares objects.
`Ssn`	`errorDetails(ErrorDetails errorDetails)`	errorDetails.
`Ssn`	`font(String font)`	font.
`Ssn`	`fontColor(String fontColor)`	fontColor.
`Ssn`	`fontColorMetadata(PropertyMetadata fontColorMetadata)`	fontColorMetadata.
`Ssn`	`fontMetadata(PropertyMetadata fontMetadata)`	fontMetadata.
`Ssn`	`fontSize(String fontSize)`	fontSize.
`Ssn`	`fontSizeMetadata(PropertyMetadata fontSizeMetadata)`	fontSizeMetadata.
`Ssn`	`formOrder(String formOrder)`	formOrder.
`Ssn`	`formOrderMetadata(PropertyMetadata formOrderMetadata)`	formOrderMetadata.
`Ssn`	`formPageLabel(String formPageLabel)`	formPageLabel.
`Ssn`	`formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`	formPageLabelMetadata.
`Ssn`	`formPageNumber(String formPageNumber)`	formPageNumber.
`Ssn`	`formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`	formPageNumberMetadata.
`String`	`getAnchorAllowWhiteSpaceInCharacters()`	.
`PropertyMetadata`	`getAnchorAllowWhiteSpaceInCharactersMetadata()`	Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..
`String`	`getAnchorCaseSensitive()`	When set to true, the anchor string does not consider case when matching strings in the document.
`PropertyMetadata`	`getAnchorCaseSensitiveMetadata()`	Metadata that indicates whether the `anchorCaseSensitive` property is editable..
`String`	`getAnchorHorizontalAlignment()`	Specifies the alignment of anchor tabs with anchor strings.
`PropertyMetadata`	`getAnchorHorizontalAlignmentMetadata()`	Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..
`String`	`getAnchorIgnoreIfNotPresent()`	When set to true, this tab is ignored if anchorString is not found in the document..
`PropertyMetadata`	`getAnchorIgnoreIfNotPresentMetadata()`	Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..
`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()`	Metadata that indicates whether the `anchorMatchWholeWord` property is editable..
`String`	`getAnchorString()`	Anchor text information for a radio button..
`PropertyMetadata`	`getAnchorStringMetadata()`	Metadata that indicates whether the `anchorString` property is editable..
`String`	`getAnchorTabProcessorVersion()`	.
`PropertyMetadata`	`getAnchorTabProcessorVersionMetadata()`	Reserved for DocuSign..
`String`	`getAnchorUnits()`	Specifies units of the X and Y offset.
`PropertyMetadata`	`getAnchorUnitsMetadata()`	Metadata that indicates whether the `anchorUnits` property is editable..
`String`	`getAnchorXOffset()`	Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
`PropertyMetadata`	`getAnchorXOffsetMetadata()`	Metadata that indicates whether the `anchorXOffset` property is editable..
`String`	`getAnchorYOffset()`	Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
`PropertyMetadata`	`getAnchorYOffsetMetadata()`	Metadata that indicates whether the `anchorYOffset` property is editable..
`String`	`getBold()`	When set to true, the information in the tab is bold..
`PropertyMetadata`	`getBoldMetadata()`	Metadata that indicates whether the `bold` property is editable..
`String`	`getCaption()`	.
`PropertyMetadata`	`getCaptionMetadata()`	.
`String`	`getConcealValueOnDocument()`	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.
`PropertyMetadata`	`getConcealValueOnDocumentMetadata()`	Metadata that indicates whether the `concealValueOnDocument` property is editable..
`String`	`getConditionalParentLabel()`	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..
`PropertyMetadata`	`getConditionalParentLabelMetadata()`	Metadata that indicates whether the `conditionalParentLabel` property is editable..
`String`	`getConditionalParentValue()`	For conditional fields, this is the value of the parent tab that controls the tab's visibility.
`PropertyMetadata`	`getConditionalParentValueMetadata()`	Metadata that indicates whether the `conditionalParentValue` property is editable..
`String`	`getCustomTabId()`	The DocuSign generated custom tab ID for the custom tab to be applied.
`PropertyMetadata`	`getCustomTabIdMetadata()`	Metadata that indicates whether the `customTabId` property is editable..
`String`	`getDisableAutoSize()`	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
`PropertyMetadata`	`getDisableAutoSizeMetadata()`	Metadata that indicates whether the `disableAutoSize` property is editable..
`String`	`getDocumentId()`	Specifies the document ID number that the tab is placed on.
`PropertyMetadata`	`getDocumentIdMetadata()`	Metadata that indicates whether the `documentId` property is editable..
`ErrorDetails`	`getErrorDetails()`	Array or errors..
`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()`	Metadata that indicates whether the `fontColor` property is editable..
`PropertyMetadata`	`getFontMetadata()`	Metadata that indicates whether the `font` property is editable..
`String`	`getFontSize()`	The font size used for the information in the tab.
`PropertyMetadata`	`getFontSizeMetadata()`	Metadata that indicates whether the `fontSize` property is editable..
`String`	`getFormOrder()`	.
`PropertyMetadata`	`getFormOrderMetadata()`	Metadata that indicates whether the `formOrder` property is editable..
`String`	`getFormPageLabel()`	.
`PropertyMetadata`	`getFormPageLabelMetadata()`	Metadata that indicates whether the `formPageLabel` property is editable..
`String`	`getFormPageNumber()`	.
`PropertyMetadata`	`getFormPageNumberMetadata()`	Metadata that indicates whether the `fromPageNumber` property is editable..
`String`	`getHeight()`	Height of the tab in pixels..
`PropertyMetadata`	`getHeightMetadata()`	Metadata that indicates whether the `height` property is editable..
`String`	`getItalic()`	When set to true, the information in the tab is italic..
`PropertyMetadata`	`getItalicMetadata()`	Metadata that indicates whether the `italic` property is editable..
`LocalePolicyTab`	`getLocalePolicy()`	Reserved for DocuSign..
`String`	`getLocked()`	When set to true, the signer cannot change the data of the custom tab..
`PropertyMetadata`	`getLockedMetadata()`	Metadata that indicates whether the `locked` property is editable..
`String`	`getMaxLength()`	An optional value that describes the maximum length of the property when the property is a string..
`PropertyMetadata`	`getMaxLengthMetadata()`	Metadata that indicates whether the `maxLength` property is editable..
`MergeField`	`getMergeField()`	Contains the information necessary to map the tab to a field in SalesForce..
`String`	`getMergeFieldXml()`	.
`String`	`getName()`	Specifies the tool tip text for the tab..
`PropertyMetadata`	`getNameMetadata()`	Metadata that indicates whether the `name` property is editable.
`String`	`getOriginalValue()`	The initial value of the tab when it was sent to the recipient.
`PropertyMetadata`	`getOriginalValueMetadata()`	Metadata that indicates whether the `originalValue` property is editable..
`String`	`getPageNumber()`	Specifies the page number on which the tab is located..
`PropertyMetadata`	`getPageNumberMetadata()`	Metadata that indicates whether the `pageNumber` property is editable..
`String`	`getRecipientId()`	Unique for the recipient.
`String`	`getRecipientIdGuid()`	.
`PropertyMetadata`	`getRecipientIdGuidMetadata()`	Metadata that indicates whether the `recipientIdGuid` property is editable..
`PropertyMetadata`	`getRecipientIdMetadata()`	Metadata that indicates whether the `recipientId` property is editable..
`String`	`getRequireAll()`	When set to true and shared is true, information must be entered in this field to complete the envelope.
`PropertyMetadata`	`getRequireAllMetadata()`	Metadata that indicates whether the `requireAll` property is editable..
`String`	`getRequired()`	When set to true, the signer is required to fill out this tab.
`PropertyMetadata`	`getRequiredMetadata()`	Metadata that indicates whether the `required` property is editable..
`String`	`getRequireInitialOnSharedChange()`	Optional element for field markup.
`PropertyMetadata`	`getRequireInitialOnSharedChangeMetadata()`	Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
`String`	`getSenderRequired()`	When set to true, the sender must populate the tab before an envelope can be sent using the template.
`PropertyMetadata`	`getSenderRequiredMetadata()`	Metadata that indicates whether the `senderRequired` property is editable..
`String`	`getShared()`	When set to true, this custom tab is shared..
`PropertyMetadata`	`getSharedMetadata()`	Metadata that indicates whether the `shared` property is editable..
`String`	`getShareToRecipients()`	.
`PropertyMetadata`	`getShareToRecipientsMetadata()`	Reserved for DocuSign..
`SmartContractInformation`	`getSmartContractInformation()`	Reserved for DocuSign..
`String`	`getSource()`	.
`String`	`getStatus()`	Indicates the envelope status.
`PropertyMetadata`	`getStatusMetadata()`	Metadata that indicates whether the `status` property is editable..
`List<String>`	`getTabGroupLabels()`	.
`PropertyMetadata`	`getTabGroupLabelsMetadata()`	Metadata that indicates whether the `tabGroupLabels` property is editable..
`String`	`getTabId()`	The unique identifier for the tab.
`PropertyMetadata`	`getTabIdMetadata()`	Metadata that indicates whether the `tabId` property is editable..
`String`	`getTabLabel()`	The label string associated with the tab..
`PropertyMetadata`	`getTabLabelMetadata()`	Metadata that indicates whether the `tabLabel` property is editable..
`String`	`getTabOrder()`	.
`PropertyMetadata`	`getTabOrderMetadata()`	Metadata that indicates whether the `tabOrder` property is editable..
`String`	`getTabType()`	.
`PropertyMetadata`	`getTabTypeMetadata()`	Metadata that indicates whether the `tabType` property is editable..
`String`	`getTemplateLocked()`	When set to true, the sender cannot change any attributes of the recipient.
`PropertyMetadata`	`getTemplateLockedMetadata()`	Metadata that indicates whether the `templateLocked` property is editable..
`String`	`getTemplateRequired()`	When set to true, the sender may not remove the recipient.
`PropertyMetadata`	`getTemplateRequiredMetadata()`	Metadata that indicates whether the `templateRequired` property is editable..
`String`	`getTooltip()`	.
`PropertyMetadata`	`getToolTipMetadata()`	Metadata that indicates whether the `toolTip` property is editable..
`String`	`getUnderline()`	When set to true, the information in the tab is underlined..
`PropertyMetadata`	`getUnderlineMetadata()`	Metadata that indicates whether the `underline` property is editable..
`String`	`getValidationMessage()`	The message displayed if the custom tab fails input validation (either custom of embedded)..
`PropertyMetadata`	`getValidationMessageMetadata()`	Metadata that indicates whether the `validationMessage` property is editable..
`String`	`getValidationPattern()`	A regular expression used to validate input for the tab..
`PropertyMetadata`	`getValidationPatternMetadata()`	Metadata that indicates whether the `validationPattern` property is editable..
`String`	`getValue()`	Specifies the value of the tab.
`PropertyMetadata`	`getValueMetadata()`	Metadata that indicates whether the `value` property is editable..
`String`	`getWidth()`	Width of the tab in pixels..
`PropertyMetadata`	`getWidthMetadata()`	Metadata that indicates whether the `width` property is editable..
`String`	`getXPosition()`	This indicates the horizontal offset of the object on the page.
`PropertyMetadata`	`getXPositionMetadata()`	Metadata that indicates whether the `xPosition` property is editable..
`String`	`getYPosition()`	This indicates the vertical offset of the object on the page.
`PropertyMetadata`	`getYPositionMetadata()`	Metadata that indicates whether the `yPosition` property is editable..
`int`	`hashCode()`	Returns the HashCode.
`Ssn`	`height(String height)`	height.
`Ssn`	`heightMetadata(PropertyMetadata heightMetadata)`	heightMetadata.
`Ssn`	`italic(String italic)`	italic.
`Ssn`	`italicMetadata(PropertyMetadata italicMetadata)`	italicMetadata.
`Ssn`	`localePolicy(LocalePolicyTab localePolicy)`	localePolicy.
`Ssn`	`locked(String locked)`	locked.
`Ssn`	`lockedMetadata(PropertyMetadata lockedMetadata)`	lockedMetadata.
`Ssn`	`maxLength(String maxLength)`	maxLength.
`Ssn`	`maxLengthMetadata(PropertyMetadata maxLengthMetadata)`	maxLengthMetadata.
`Ssn`	`mergeField(MergeField mergeField)`	mergeField.
`Ssn`	`mergeFieldXml(String mergeFieldXml)`	mergeFieldXml.
`Ssn`	`name(String name)`	name.
`Ssn`	`nameMetadata(PropertyMetadata nameMetadata)`	nameMetadata.
`Ssn`	`originalValue(String originalValue)`	originalValue.
`Ssn`	`originalValueMetadata(PropertyMetadata originalValueMetadata)`	originalValueMetadata.
`Ssn`	`pageNumber(String pageNumber)`	pageNumber.
`Ssn`	`pageNumberMetadata(PropertyMetadata pageNumberMetadata)`	pageNumberMetadata.
`Ssn`	`recipientId(String recipientId)`	recipientId.
`Ssn`	`recipientIdGuid(String recipientIdGuid)`	recipientIdGuid.
`Ssn`	`recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`	recipientIdGuidMetadata.
`Ssn`	`recipientIdMetadata(PropertyMetadata recipientIdMetadata)`	recipientIdMetadata.
`Ssn`	`requireAll(String requireAll)`	requireAll.
`Ssn`	`requireAllMetadata(PropertyMetadata requireAllMetadata)`	requireAllMetadata.
`Ssn`	`required(String required)`	required.
`Ssn`	`requiredMetadata(PropertyMetadata requiredMetadata)`	requiredMetadata.
`Ssn`	`requireInitialOnSharedChange(String requireInitialOnSharedChange)`	requireInitialOnSharedChange.
`Ssn`	`requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`	requireInitialOnSharedChangeMetadata.
`Ssn`	`senderRequired(String senderRequired)`	senderRequired.
`Ssn`	`senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`	senderRequiredMetadata.
`void`	`setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)`	setAnchorAllowWhiteSpaceInCharacters.
`void`	`setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)`	setAnchorAllowWhiteSpaceInCharactersMetadata.
`void`	`setAnchorCaseSensitive(String anchorCaseSensitive)`	setAnchorCaseSensitive.
`void`	`setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)`	setAnchorCaseSensitiveMetadata.
`void`	`setAnchorHorizontalAlignment(String anchorHorizontalAlignment)`	setAnchorHorizontalAlignment.
`void`	`setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)`	setAnchorHorizontalAlignmentMetadata.
`void`	`setAnchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)`	setAnchorIgnoreIfNotPresent.
`void`	`setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)`	setAnchorIgnoreIfNotPresentMetadata.
`void`	`setAnchorMatchWholeWord(String anchorMatchWholeWord)`	setAnchorMatchWholeWord.
`void`	`setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)`	setAnchorMatchWholeWordMetadata.
`void`	`setAnchorString(String anchorString)`	setAnchorString.
`void`	`setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)`	setAnchorStringMetadata.
`void`	`setAnchorTabProcessorVersion(String anchorTabProcessorVersion)`	setAnchorTabProcessorVersion.
`void`	`setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)`	setAnchorTabProcessorVersionMetadata.
`void`	`setAnchorUnits(String anchorUnits)`	setAnchorUnits.
`void`	`setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)`	setAnchorUnitsMetadata.
`void`	`setAnchorXOffset(String anchorXOffset)`	setAnchorXOffset.
`void`	`setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)`	setAnchorXOffsetMetadata.
`void`	`setAnchorYOffset(String anchorYOffset)`	setAnchorYOffset.
`void`	`setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)`	setAnchorYOffsetMetadata.
`void`	`setBold(String bold)`	setBold.
`void`	`setBoldMetadata(PropertyMetadata boldMetadata)`	setBoldMetadata.
`void`	`setCaption(String caption)`	setCaption.
`void`	`setCaptionMetadata(PropertyMetadata captionMetadata)`	setCaptionMetadata.
`void`	`setConcealValueOnDocument(String concealValueOnDocument)`	setConcealValueOnDocument.
`void`	`setConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)`	setConcealValueOnDocumentMetadata.
`void`	`setConditionalParentLabel(String conditionalParentLabel)`	setConditionalParentLabel.
`void`	`setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)`	setConditionalParentLabelMetadata.
`void`	`setConditionalParentValue(String conditionalParentValue)`	setConditionalParentValue.
`void`	`setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)`	setConditionalParentValueMetadata.
`void`	`setCustomTabId(String customTabId)`	setCustomTabId.
`void`	`setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)`	setCustomTabIdMetadata.
`void`	`setDisableAutoSize(String disableAutoSize)`	setDisableAutoSize.
`void`	`setDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)`	setDisableAutoSizeMetadata.
`void`	`setDocumentId(String documentId)`	setDocumentId.
`void`	`setDocumentIdMetadata(PropertyMetadata documentIdMetadata)`	setDocumentIdMetadata.
`void`	`setErrorDetails(ErrorDetails errorDetails)`	setErrorDetails.
`void`	`setFont(String font)`	setFont.
`void`	`setFontColor(String fontColor)`	setFontColor.
`void`	`setFontColorMetadata(PropertyMetadata fontColorMetadata)`	setFontColorMetadata.
`void`	`setFontMetadata(PropertyMetadata fontMetadata)`	setFontMetadata.
`void`	`setFontSize(String fontSize)`	setFontSize.
`void`	`setFontSizeMetadata(PropertyMetadata fontSizeMetadata)`	setFontSizeMetadata.
`void`	`setFormOrder(String formOrder)`	setFormOrder.
`void`	`setFormOrderMetadata(PropertyMetadata formOrderMetadata)`	setFormOrderMetadata.
`void`	`setFormPageLabel(String formPageLabel)`	setFormPageLabel.
`void`	`setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)`	setFormPageLabelMetadata.
`void`	`setFormPageNumber(String formPageNumber)`	setFormPageNumber.
`void`	`setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)`	setFormPageNumberMetadata.
`void`	`setHeight(String height)`	setHeight.
`void`	`setHeightMetadata(PropertyMetadata heightMetadata)`	setHeightMetadata.
`void`	`setItalic(String italic)`	setItalic.
`void`	`setItalicMetadata(PropertyMetadata italicMetadata)`	setItalicMetadata.
`void`	`setLocalePolicy(LocalePolicyTab localePolicy)`	setLocalePolicy.
`void`	`setLocked(String locked)`	setLocked.
`void`	`setLockedMetadata(PropertyMetadata lockedMetadata)`	setLockedMetadata.
`void`	`setMaxLength(String maxLength)`	setMaxLength.
`void`	`setMaxLengthMetadata(PropertyMetadata maxLengthMetadata)`	setMaxLengthMetadata.
`void`	`setMergeField(MergeField mergeField)`	setMergeField.
`void`	`setMergeFieldXml(String mergeFieldXml)`	setMergeFieldXml.
`void`	`setName(String name)`	setName.
`void`	`setNameMetadata(PropertyMetadata nameMetadata)`	setNameMetadata.
`void`	`setOriginalValue(String originalValue)`	setOriginalValue.
`void`	`setOriginalValueMetadata(PropertyMetadata originalValueMetadata)`	setOriginalValueMetadata.
`void`	`setPageNumber(String pageNumber)`	setPageNumber.
`void`	`setPageNumberMetadata(PropertyMetadata pageNumberMetadata)`	setPageNumberMetadata.
`void`	`setRecipientId(String recipientId)`	setRecipientId.
`void`	`setRecipientIdGuid(String recipientIdGuid)`	setRecipientIdGuid.
`void`	`setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)`	setRecipientIdGuidMetadata.
`void`	`setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)`	setRecipientIdMetadata.
`void`	`setRequireAll(String requireAll)`	setRequireAll.
`void`	`setRequireAllMetadata(PropertyMetadata requireAllMetadata)`	setRequireAllMetadata.
`void`	`setRequired(String required)`	setRequired.
`void`	`setRequiredMetadata(PropertyMetadata requiredMetadata)`	setRequiredMetadata.
`void`	`setRequireInitialOnSharedChange(String requireInitialOnSharedChange)`	setRequireInitialOnSharedChange.
`void`	`setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)`	setRequireInitialOnSharedChangeMetadata.
`void`	`setSenderRequired(String senderRequired)`	setSenderRequired.
`void`	`setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)`	setSenderRequiredMetadata.
`void`	`setShared(String shared)`	setShared.
`void`	`setSharedMetadata(PropertyMetadata sharedMetadata)`	setSharedMetadata.
`void`	`setShareToRecipients(String shareToRecipients)`	setShareToRecipients.
`void`	`setShareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)`	setShareToRecipientsMetadata.
`void`	`setSmartContractInformation(SmartContractInformation smartContractInformation)`	setSmartContractInformation.
`void`	`setSource(String source)`	setSource.
`void`	`setStatus(String status)`	setStatus.
`void`	`setStatusMetadata(PropertyMetadata statusMetadata)`	setStatusMetadata.
`void`	`setTabGroupLabels(List<String> tabGroupLabels)`	setTabGroupLabels.
`void`	`setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`	setTabGroupLabelsMetadata.
`void`	`setTabId(String tabId)`	setTabId.
`void`	`setTabIdMetadata(PropertyMetadata tabIdMetadata)`	setTabIdMetadata.
`void`	`setTabLabel(String tabLabel)`	setTabLabel.
`void`	`setTabLabelMetadata(PropertyMetadata tabLabelMetadata)`	setTabLabelMetadata.
`void`	`setTabOrder(String tabOrder)`	setTabOrder.
`void`	`setTabOrderMetadata(PropertyMetadata tabOrderMetadata)`	setTabOrderMetadata.
`void`	`setTabType(String tabType)`	setTabType.
`void`	`setTabTypeMetadata(PropertyMetadata tabTypeMetadata)`	setTabTypeMetadata.
`void`	`setTemplateLocked(String templateLocked)`	setTemplateLocked.
`void`	`setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)`	setTemplateLockedMetadata.
`void`	`setTemplateRequired(String templateRequired)`	setTemplateRequired.
`void`	`setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`	setTemplateRequiredMetadata.
`void`	`setTooltip(String tooltip)`	setTooltip.
`void`	`setToolTipMetadata(PropertyMetadata toolTipMetadata)`	setToolTipMetadata.
`void`	`setUnderline(String underline)`	setUnderline.
`void`	`setUnderlineMetadata(PropertyMetadata underlineMetadata)`	setUnderlineMetadata.
`void`	`setValidationMessage(String validationMessage)`	setValidationMessage.
`void`	`setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)`	setValidationMessageMetadata.
`void`	`setValidationPattern(String validationPattern)`	setValidationPattern.
`void`	`setValidationPatternMetadata(PropertyMetadata validationPatternMetadata)`	setValidationPatternMetadata.
`void`	`setValue(String value)`	setValue.
`void`	`setValueMetadata(PropertyMetadata valueMetadata)`	setValueMetadata.
`void`	`setWidth(String width)`	setWidth.
`void`	`setWidthMetadata(PropertyMetadata widthMetadata)`	setWidthMetadata.
`void`	`setXPosition(String xPosition)`	setXPosition.
`void`	`setXPositionMetadata(PropertyMetadata xPositionMetadata)`	setXPositionMetadata.
`void`	`setYPosition(String yPosition)`	setYPosition.
`void`	`setYPositionMetadata(PropertyMetadata yPositionMetadata)`	setYPositionMetadata.
`Ssn`	`shared(String shared)`	shared.
`Ssn`	`sharedMetadata(PropertyMetadata sharedMetadata)`	sharedMetadata.
`Ssn`	`shareToRecipients(String shareToRecipients)`	shareToRecipients.
`Ssn`	`shareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)`	shareToRecipientsMetadata.
`Ssn`	`smartContractInformation(SmartContractInformation smartContractInformation)`	smartContractInformation.
`Ssn`	`source(String source)`	source.
`Ssn`	`status(String status)`	status.
`Ssn`	`statusMetadata(PropertyMetadata statusMetadata)`	statusMetadata.
`Ssn`	`tabGroupLabels(List<String> tabGroupLabels)`	tabGroupLabels.
`Ssn`	`tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)`	tabGroupLabelsMetadata.
`Ssn`	`tabId(String tabId)`	tabId.
`Ssn`	`tabIdMetadata(PropertyMetadata tabIdMetadata)`	tabIdMetadata.
`Ssn`	`tabLabel(String tabLabel)`	tabLabel.
`Ssn`	`tabLabelMetadata(PropertyMetadata tabLabelMetadata)`	tabLabelMetadata.
`Ssn`	`tabOrder(String tabOrder)`	tabOrder.
`Ssn`	`tabOrderMetadata(PropertyMetadata tabOrderMetadata)`	tabOrderMetadata.
`Ssn`	`tabType(String tabType)`	tabType.
`Ssn`	`tabTypeMetadata(PropertyMetadata tabTypeMetadata)`	tabTypeMetadata.
`Ssn`	`templateLocked(String templateLocked)`	templateLocked.
`Ssn`	`templateLockedMetadata(PropertyMetadata templateLockedMetadata)`	templateLockedMetadata.
`Ssn`	`templateRequired(String templateRequired)`	templateRequired.
`Ssn`	`templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)`	templateRequiredMetadata.
`Ssn`	`tooltip(String tooltip)`	tooltip.
`Ssn`	`toolTipMetadata(PropertyMetadata toolTipMetadata)`	toolTipMetadata.
`String`	`toString()`	Converts the given object to string.
`Ssn`	`underline(String underline)`	underline.
`Ssn`	`underlineMetadata(PropertyMetadata underlineMetadata)`	underlineMetadata.
`Ssn`	`validationMessage(String validationMessage)`	validationMessage.
`Ssn`	`validationMessageMetadata(PropertyMetadata validationMessageMetadata)`	validationMessageMetadata.
`Ssn`	`validationPattern(String validationPattern)`	validationPattern.
`Ssn`	`validationPatternMetadata(PropertyMetadata validationPatternMetadata)`	validationPatternMetadata.
`Ssn`	`value(String value)`	value.
`Ssn`	`valueMetadata(PropertyMetadata valueMetadata)`	valueMetadata.
`Ssn`	`width(String width)`	width.
`Ssn`	`widthMetadata(PropertyMetadata widthMetadata)`	widthMetadata.
`Ssn`	`xPosition(String xPosition)`	xPosition.
`Ssn`	`xPositionMetadata(PropertyMetadata xPositionMetadata)`	xPositionMetadata.
`Ssn`	`yPosition(String yPosition)`	yPosition.
`Ssn`	`yPositionMetadata(PropertyMetadata yPositionMetadata)`	yPositionMetadata.

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

- Constructor Detail
  - Ssn
```
public Ssn()
```
- Method Detail
  - anchorAllowWhiteSpaceInCharacters
```
public Ssn anchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
```
    anchorAllowWhiteSpaceInCharacters.
    
    Returns:
    
    Ssn
  - getAnchorAllowWhiteSpaceInCharacters
```
public String getAnchorAllowWhiteSpaceInCharacters()
```
    .
    
    Returns:
    
    anchorAllowWhiteSpaceInCharacters
  - setAnchorAllowWhiteSpaceInCharacters
```
public void setAnchorAllowWhiteSpaceInCharacters(String anchorAllowWhiteSpaceInCharacters)
```
    setAnchorAllowWhiteSpaceInCharacters.
  - anchorAllowWhiteSpaceInCharactersMetadata
```
public Ssn anchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
```
    anchorAllowWhiteSpaceInCharactersMetadata.
    
    Returns:
    
    Ssn
  - getAnchorAllowWhiteSpaceInCharactersMetadata
```
public PropertyMetadata getAnchorAllowWhiteSpaceInCharactersMetadata()
```
    Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable..
    
    Returns:
    
    anchorAllowWhiteSpaceInCharactersMetadata
  - setAnchorAllowWhiteSpaceInCharactersMetadata
```
public void setAnchorAllowWhiteSpaceInCharactersMetadata(PropertyMetadata anchorAllowWhiteSpaceInCharactersMetadata)
```
    setAnchorAllowWhiteSpaceInCharactersMetadata.
  - anchorCaseSensitive
```
public Ssn anchorCaseSensitive(String anchorCaseSensitive)
```
    anchorCaseSensitive.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorCaseSensitive.
  - anchorCaseSensitiveMetadata
```
public Ssn anchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
```
    anchorCaseSensitiveMetadata.
    
    Returns:
    
    Ssn
  - getAnchorCaseSensitiveMetadata
```
public PropertyMetadata getAnchorCaseSensitiveMetadata()
```
    Metadata that indicates whether the `anchorCaseSensitive` property is editable..
    
    Returns:
    
    anchorCaseSensitiveMetadata
  - setAnchorCaseSensitiveMetadata
```
public void setAnchorCaseSensitiveMetadata(PropertyMetadata anchorCaseSensitiveMetadata)
```
    setAnchorCaseSensitiveMetadata.
  - anchorHorizontalAlignment
```
public Ssn anchorHorizontalAlignment(String anchorHorizontalAlignment)
```
    anchorHorizontalAlignment.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorHorizontalAlignment.
  - anchorHorizontalAlignmentMetadata
```
public Ssn anchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
```
    anchorHorizontalAlignmentMetadata.
    
    Returns:
    
    Ssn
  - getAnchorHorizontalAlignmentMetadata
```
public PropertyMetadata getAnchorHorizontalAlignmentMetadata()
```
    Metadata that indicates whether the `anchorHorizontalAlignment` property is editable..
    
    Returns:
    
    anchorHorizontalAlignmentMetadata
  - setAnchorHorizontalAlignmentMetadata
```
public void setAnchorHorizontalAlignmentMetadata(PropertyMetadata anchorHorizontalAlignmentMetadata)
```
    setAnchorHorizontalAlignmentMetadata.
  - anchorIgnoreIfNotPresent
```
public Ssn anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent)
```
    anchorIgnoreIfNotPresent.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorIgnoreIfNotPresent.
  - anchorIgnoreIfNotPresentMetadata
```
public Ssn anchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
```
    anchorIgnoreIfNotPresentMetadata.
    
    Returns:
    
    Ssn
  - getAnchorIgnoreIfNotPresentMetadata
```
public PropertyMetadata getAnchorIgnoreIfNotPresentMetadata()
```
    Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable..
    
    Returns:
    
    anchorIgnoreIfNotPresentMetadata
  - setAnchorIgnoreIfNotPresentMetadata
```
public void setAnchorIgnoreIfNotPresentMetadata(PropertyMetadata anchorIgnoreIfNotPresentMetadata)
```
    setAnchorIgnoreIfNotPresentMetadata.
  - anchorMatchWholeWord
```
public Ssn anchorMatchWholeWord(String anchorMatchWholeWord)
```
    anchorMatchWholeWord.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorMatchWholeWord.
  - anchorMatchWholeWordMetadata
```
public Ssn anchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
```
    anchorMatchWholeWordMetadata.
    
    Returns:
    
    Ssn
  - getAnchorMatchWholeWordMetadata
```
public PropertyMetadata getAnchorMatchWholeWordMetadata()
```
    Metadata that indicates whether the `anchorMatchWholeWord` property is editable..
    
    Returns:
    
    anchorMatchWholeWordMetadata
  - setAnchorMatchWholeWordMetadata
```
public void setAnchorMatchWholeWordMetadata(PropertyMetadata anchorMatchWholeWordMetadata)
```
    setAnchorMatchWholeWordMetadata.
  - anchorString
```
public Ssn anchorString(String anchorString)
```
    anchorString.
    
    Returns:
    
    Ssn
  - getAnchorString
```
public String getAnchorString()
```
    Anchor text information for a radio button..
    
    Returns:
    
    anchorString
  - setAnchorString
```
public void setAnchorString(String anchorString)
```
    setAnchorString.
  - anchorStringMetadata
```
public Ssn anchorStringMetadata(PropertyMetadata anchorStringMetadata)
```
    anchorStringMetadata.
    
    Returns:
    
    Ssn
  - getAnchorStringMetadata
```
public PropertyMetadata getAnchorStringMetadata()
```
    Metadata that indicates whether the `anchorString` property is editable..
    
    Returns:
    
    anchorStringMetadata
  - setAnchorStringMetadata
```
public void setAnchorStringMetadata(PropertyMetadata anchorStringMetadata)
```
    setAnchorStringMetadata.
  - anchorTabProcessorVersion
```
public Ssn anchorTabProcessorVersion(String anchorTabProcessorVersion)
```
    anchorTabProcessorVersion.
    
    Returns:
    
    Ssn
  - getAnchorTabProcessorVersion
```
public String getAnchorTabProcessorVersion()
```
    .
    
    Returns:
    
    anchorTabProcessorVersion
  - setAnchorTabProcessorVersion
```
public void setAnchorTabProcessorVersion(String anchorTabProcessorVersion)
```
    setAnchorTabProcessorVersion.
  - anchorTabProcessorVersionMetadata
```
public Ssn anchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
```
    anchorTabProcessorVersionMetadata.
    
    Returns:
    
    Ssn
  - getAnchorTabProcessorVersionMetadata
```
public PropertyMetadata getAnchorTabProcessorVersionMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    anchorTabProcessorVersionMetadata
  - setAnchorTabProcessorVersionMetadata
```
public void setAnchorTabProcessorVersionMetadata(PropertyMetadata anchorTabProcessorVersionMetadata)
```
    setAnchorTabProcessorVersionMetadata.
  - anchorUnits
```
public Ssn anchorUnits(String anchorUnits)
```
    anchorUnits.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorUnits.
  - anchorUnitsMetadata
```
public Ssn anchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
```
    anchorUnitsMetadata.
    
    Returns:
    
    Ssn
  - getAnchorUnitsMetadata
```
public PropertyMetadata getAnchorUnitsMetadata()
```
    Metadata that indicates whether the `anchorUnits` property is editable..
    
    Returns:
    
    anchorUnitsMetadata
  - setAnchorUnitsMetadata
```
public void setAnchorUnitsMetadata(PropertyMetadata anchorUnitsMetadata)
```
    setAnchorUnitsMetadata.
  - anchorXOffset
```
public Ssn anchorXOffset(String anchorXOffset)
```
    anchorXOffset.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorXOffset.
  - anchorXOffsetMetadata
```
public Ssn anchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
```
    anchorXOffsetMetadata.
    
    Returns:
    
    Ssn
  - getAnchorXOffsetMetadata
```
public PropertyMetadata getAnchorXOffsetMetadata()
```
    Metadata that indicates whether the `anchorXOffset` property is editable..
    
    Returns:
    
    anchorXOffsetMetadata
  - setAnchorXOffsetMetadata
```
public void setAnchorXOffsetMetadata(PropertyMetadata anchorXOffsetMetadata)
```
    setAnchorXOffsetMetadata.
  - anchorYOffset
```
public Ssn anchorYOffset(String anchorYOffset)
```
    anchorYOffset.
    
    Returns:
    
    Ssn
  - 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)
```
    setAnchorYOffset.
  - anchorYOffsetMetadata
```
public Ssn anchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
```
    anchorYOffsetMetadata.
    
    Returns:
    
    Ssn
  - getAnchorYOffsetMetadata
```
public PropertyMetadata getAnchorYOffsetMetadata()
```
    Metadata that indicates whether the `anchorYOffset` property is editable..
    
    Returns:
    
    anchorYOffsetMetadata
  - setAnchorYOffsetMetadata
```
public void setAnchorYOffsetMetadata(PropertyMetadata anchorYOffsetMetadata)
```
    setAnchorYOffsetMetadata.
  - bold
```
public Ssn bold(String bold)
```
    bold.
    
    Returns:
    
    Ssn
  - getBold
```
public String getBold()
```
    When set to **true**, the information in the tab is bold..
    
    Returns:
    
    bold
  - setBold
```
public void setBold(String bold)
```
    setBold.
  - boldMetadata
```
public Ssn boldMetadata(PropertyMetadata boldMetadata)
```
    boldMetadata.
    
    Returns:
    
    Ssn
  - getBoldMetadata
```
public PropertyMetadata getBoldMetadata()
```
    Metadata that indicates whether the `bold` property is editable..
    
    Returns:
    
    boldMetadata
  - setBoldMetadata
```
public void setBoldMetadata(PropertyMetadata boldMetadata)
```
    setBoldMetadata.
  - caption
```
public Ssn caption(String caption)
```
    caption.
    
    Returns:
    
    Ssn
  - getCaption
```
public String getCaption()
```
    .
    
    Returns:
    
    caption
  - setCaption
```
public void setCaption(String caption)
```
    setCaption.
  - captionMetadata
```
public Ssn captionMetadata(PropertyMetadata captionMetadata)
```
    captionMetadata.
    
    Returns:
    
    Ssn
  - getCaptionMetadata
```
public PropertyMetadata getCaptionMetadata()
```
    .
    
    Returns:
    
    captionMetadata
  - setCaptionMetadata
```
public void setCaptionMetadata(PropertyMetadata captionMetadata)
```
    setCaptionMetadata.
  - concealValueOnDocument
```
public Ssn concealValueOnDocument(String concealValueOnDocument)
```
    concealValueOnDocument.
    
    Returns:
    
    Ssn
  - getConcealValueOnDocument
```
public String getConcealValueOnDocument()
```
    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..
    
    Returns:
    
    concealValueOnDocument
  - setConcealValueOnDocument
```
public void setConcealValueOnDocument(String concealValueOnDocument)
```
    setConcealValueOnDocument.
  - concealValueOnDocumentMetadata
```
public Ssn concealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)
```
    concealValueOnDocumentMetadata.
    
    Returns:
    
    Ssn
  - getConcealValueOnDocumentMetadata
```
public PropertyMetadata getConcealValueOnDocumentMetadata()
```
    Metadata that indicates whether the `concealValueOnDocument` property is editable..
    
    Returns:
    
    concealValueOnDocumentMetadata
  - setConcealValueOnDocumentMetadata
```
public void setConcealValueOnDocumentMetadata(PropertyMetadata concealValueOnDocumentMetadata)
```
    setConcealValueOnDocumentMetadata.
  - conditionalParentLabel
```
public Ssn conditionalParentLabel(String conditionalParentLabel)
```
    conditionalParentLabel.
    
    Returns:
    
    Ssn
  - 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)
```
    setConditionalParentLabel.
  - conditionalParentLabelMetadata
```
public Ssn conditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
```
    conditionalParentLabelMetadata.
    
    Returns:
    
    Ssn
  - getConditionalParentLabelMetadata
```
public PropertyMetadata getConditionalParentLabelMetadata()
```
    Metadata that indicates whether the `conditionalParentLabel` property is editable..
    
    Returns:
    
    conditionalParentLabelMetadata
  - setConditionalParentLabelMetadata
```
public void setConditionalParentLabelMetadata(PropertyMetadata conditionalParentLabelMetadata)
```
    setConditionalParentLabelMetadata.
  - conditionalParentValue
```
public Ssn conditionalParentValue(String conditionalParentValue)
```
    conditionalParentValue.
    
    Returns:
    
    Ssn
  - 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)
```
    setConditionalParentValue.
  - conditionalParentValueMetadata
```
public Ssn conditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
```
    conditionalParentValueMetadata.
    
    Returns:
    
    Ssn
  - getConditionalParentValueMetadata
```
public PropertyMetadata getConditionalParentValueMetadata()
```
    Metadata that indicates whether the `conditionalParentValue` property is editable..
    
    Returns:
    
    conditionalParentValueMetadata
  - setConditionalParentValueMetadata
```
public void setConditionalParentValueMetadata(PropertyMetadata conditionalParentValueMetadata)
```
    setConditionalParentValueMetadata.
  - customTabId
```
public Ssn customTabId(String customTabId)
```
    customTabId.
    
    Returns:
    
    Ssn
  - 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)
```
    setCustomTabId.
  - customTabIdMetadata
```
public Ssn customTabIdMetadata(PropertyMetadata customTabIdMetadata)
```
    customTabIdMetadata.
    
    Returns:
    
    Ssn
  - getCustomTabIdMetadata
```
public PropertyMetadata getCustomTabIdMetadata()
```
    Metadata that indicates whether the `customTabId` property is editable..
    
    Returns:
    
    customTabIdMetadata
  - setCustomTabIdMetadata
```
public void setCustomTabIdMetadata(PropertyMetadata customTabIdMetadata)
```
    setCustomTabIdMetadata.
  - disableAutoSize
```
public Ssn disableAutoSize(String disableAutoSize)
```
    disableAutoSize.
    
    Returns:
    
    Ssn
  - getDisableAutoSize
```
public String getDisableAutoSize()
```
    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..
    
    Returns:
    
    disableAutoSize
  - setDisableAutoSize
```
public void setDisableAutoSize(String disableAutoSize)
```
    setDisableAutoSize.
  - disableAutoSizeMetadata
```
public Ssn disableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)
```
    disableAutoSizeMetadata.
    
    Returns:
    
    Ssn
  - getDisableAutoSizeMetadata
```
public PropertyMetadata getDisableAutoSizeMetadata()
```
    Metadata that indicates whether the `disableAutoSize` property is editable..
    
    Returns:
    
    disableAutoSizeMetadata
  - setDisableAutoSizeMetadata
```
public void setDisableAutoSizeMetadata(PropertyMetadata disableAutoSizeMetadata)
```
    setDisableAutoSizeMetadata.
  - documentId
```
public Ssn documentId(String documentId)
```
    documentId.
    
    Returns:
    
    Ssn
  - 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)
```
    setDocumentId.
  - documentIdMetadata
```
public Ssn documentIdMetadata(PropertyMetadata documentIdMetadata)
```
    documentIdMetadata.
    
    Returns:
    
    Ssn
  - getDocumentIdMetadata
```
public PropertyMetadata getDocumentIdMetadata()
```
    Metadata that indicates whether the `documentId` property is editable..
    
    Returns:
    
    documentIdMetadata
  - setDocumentIdMetadata
```
public void setDocumentIdMetadata(PropertyMetadata documentIdMetadata)
```
    setDocumentIdMetadata.
  - errorDetails
```
public Ssn errorDetails(ErrorDetails errorDetails)
```
    errorDetails.
    
    Returns:
    
    Ssn
  - getErrorDetails
```
public ErrorDetails getErrorDetails()
```
    Array or errors..
    
    Returns:
    
    errorDetails
  - setErrorDetails
```
public void setErrorDetails(ErrorDetails errorDetails)
```
    setErrorDetails.
  - font
```
public Ssn font(String font)
```
    font.
    
    Returns:
    
    Ssn
  - 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)
```
    setFont.
  - fontColor
```
public Ssn fontColor(String fontColor)
```
    fontColor.
    
    Returns:
    
    Ssn
  - 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)
```
    setFontColor.
  - fontColorMetadata
```
public Ssn fontColorMetadata(PropertyMetadata fontColorMetadata)
```
    fontColorMetadata.
    
    Returns:
    
    Ssn
  - getFontColorMetadata
```
public PropertyMetadata getFontColorMetadata()
```
    Metadata that indicates whether the `fontColor` property is editable..
    
    Returns:
    
    fontColorMetadata
  - setFontColorMetadata
```
public void setFontColorMetadata(PropertyMetadata fontColorMetadata)
```
    setFontColorMetadata.
  - fontMetadata
```
public Ssn fontMetadata(PropertyMetadata fontMetadata)
```
    fontMetadata.
    
    Returns:
    
    Ssn
  - getFontMetadata
```
public PropertyMetadata getFontMetadata()
```
    Metadata that indicates whether the `font` property is editable..
    
    Returns:
    
    fontMetadata
  - setFontMetadata
```
public void setFontMetadata(PropertyMetadata fontMetadata)
```
    setFontMetadata.
  - fontSize
```
public Ssn fontSize(String fontSize)
```
    fontSize.
    
    Returns:
    
    Ssn
  - getFontSize
```
public String getFontSize()
```
    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..
    
    Returns:
    
    fontSize
  - setFontSize
```
public void setFontSize(String fontSize)
```
    setFontSize.
  - fontSizeMetadata
```
public Ssn fontSizeMetadata(PropertyMetadata fontSizeMetadata)
```
    fontSizeMetadata.
    
    Returns:
    
    Ssn
  - getFontSizeMetadata
```
public PropertyMetadata getFontSizeMetadata()
```
    Metadata that indicates whether the `fontSize` property is editable..
    
    Returns:
    
    fontSizeMetadata
  - setFontSizeMetadata
```
public void setFontSizeMetadata(PropertyMetadata fontSizeMetadata)
```
    setFontSizeMetadata.
  - formOrder
```
public Ssn formOrder(String formOrder)
```
    formOrder.
    
    Returns:
    
    Ssn
  - getFormOrder
```
public String getFormOrder()
```
    .
    
    Returns:
    
    formOrder
  - setFormOrder
```
public void setFormOrder(String formOrder)
```
    setFormOrder.
  - formOrderMetadata
```
public Ssn formOrderMetadata(PropertyMetadata formOrderMetadata)
```
    formOrderMetadata.
    
    Returns:
    
    Ssn
  - getFormOrderMetadata
```
public PropertyMetadata getFormOrderMetadata()
```
    Metadata that indicates whether the `formOrder` property is editable..
    
    Returns:
    
    formOrderMetadata
  - setFormOrderMetadata
```
public void setFormOrderMetadata(PropertyMetadata formOrderMetadata)
```
    setFormOrderMetadata.
  - formPageLabel
```
public Ssn formPageLabel(String formPageLabel)
```
    formPageLabel.
    
    Returns:
    
    Ssn
  - getFormPageLabel
```
public String getFormPageLabel()
```
    .
    
    Returns:
    
    formPageLabel
  - setFormPageLabel
```
public void setFormPageLabel(String formPageLabel)
```
    setFormPageLabel.
  - formPageLabelMetadata
```
public Ssn formPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
```
    formPageLabelMetadata.
    
    Returns:
    
    Ssn
  - getFormPageLabelMetadata
```
public PropertyMetadata getFormPageLabelMetadata()
```
    Metadata that indicates whether the `formPageLabel` property is editable..
    
    Returns:
    
    formPageLabelMetadata
  - setFormPageLabelMetadata
```
public void setFormPageLabelMetadata(PropertyMetadata formPageLabelMetadata)
```
    setFormPageLabelMetadata.
  - formPageNumber
```
public Ssn formPageNumber(String formPageNumber)
```
    formPageNumber.
    
    Returns:
    
    Ssn
  - getFormPageNumber
```
public String getFormPageNumber()
```
    .
    
    Returns:
    
    formPageNumber
  - setFormPageNumber
```
public void setFormPageNumber(String formPageNumber)
```
    setFormPageNumber.
  - formPageNumberMetadata
```
public Ssn formPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
```
    formPageNumberMetadata.
    
    Returns:
    
    Ssn
  - getFormPageNumberMetadata
```
public PropertyMetadata getFormPageNumberMetadata()
```
    Metadata that indicates whether the `fromPageNumber` property is editable..
    
    Returns:
    
    formPageNumberMetadata
  - setFormPageNumberMetadata
```
public void setFormPageNumberMetadata(PropertyMetadata formPageNumberMetadata)
```
    setFormPageNumberMetadata.
  - height
```
public Ssn height(String height)
```
    height.
    
    Returns:
    
    Ssn
  - getHeight
```
public String getHeight()
```
    Height of the tab in pixels..
    
    Returns:
    
    height
  - setHeight
```
public void setHeight(String height)
```
    setHeight.
  - heightMetadata
```
public Ssn heightMetadata(PropertyMetadata heightMetadata)
```
    heightMetadata.
    
    Returns:
    
    Ssn
  - getHeightMetadata
```
public PropertyMetadata getHeightMetadata()
```
    Metadata that indicates whether the `height` property is editable..
    
    Returns:
    
    heightMetadata
  - setHeightMetadata
```
public void setHeightMetadata(PropertyMetadata heightMetadata)
```
    setHeightMetadata.
  - italic
```
public Ssn italic(String italic)
```
    italic.
    
    Returns:
    
    Ssn
  - getItalic
```
public String getItalic()
```
    When set to **true**, the information in the tab is italic..
    
    Returns:
    
    italic
  - setItalic
```
public void setItalic(String italic)
```
    setItalic.
  - italicMetadata
```
public Ssn italicMetadata(PropertyMetadata italicMetadata)
```
    italicMetadata.
    
    Returns:
    
    Ssn
  - getItalicMetadata
```
public PropertyMetadata getItalicMetadata()
```
    Metadata that indicates whether the `italic` property is editable..
    
    Returns:
    
    italicMetadata
  - setItalicMetadata
```
public void setItalicMetadata(PropertyMetadata italicMetadata)
```
    setItalicMetadata.
  - localePolicy
```
public Ssn localePolicy(LocalePolicyTab localePolicy)
```
    localePolicy.
    
    Returns:
    
    Ssn
  - getLocalePolicy
```
public LocalePolicyTab getLocalePolicy()
```
    Reserved for DocuSign..
    
    Returns:
    
    localePolicy
  - setLocalePolicy
```
public void setLocalePolicy(LocalePolicyTab localePolicy)
```
    setLocalePolicy.
  - locked
```
public Ssn locked(String locked)
```
    locked.
    
    Returns:
    
    Ssn
  - 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)
```
    setLocked.
  - lockedMetadata
```
public Ssn lockedMetadata(PropertyMetadata lockedMetadata)
```
    lockedMetadata.
    
    Returns:
    
    Ssn
  - getLockedMetadata
```
public PropertyMetadata getLockedMetadata()
```
    Metadata that indicates whether the `locked` property is editable..
    
    Returns:
    
    lockedMetadata
  - setLockedMetadata
```
public void setLockedMetadata(PropertyMetadata lockedMetadata)
```
    setLockedMetadata.
  - maxLength
```
public Ssn maxLength(String maxLength)
```
    maxLength.
    
    Returns:
    
    Ssn
  - getMaxLength
```
public String getMaxLength()
```
    An optional value that describes the maximum length of the property when the property is a string..
    
    Returns:
    
    maxLength
  - setMaxLength
```
public void setMaxLength(String maxLength)
```
    setMaxLength.
  - maxLengthMetadata
```
public Ssn maxLengthMetadata(PropertyMetadata maxLengthMetadata)
```
    maxLengthMetadata.
    
    Returns:
    
    Ssn
  - getMaxLengthMetadata
```
public PropertyMetadata getMaxLengthMetadata()
```
    Metadata that indicates whether the `maxLength` property is editable..
    
    Returns:
    
    maxLengthMetadata
  - setMaxLengthMetadata
```
public void setMaxLengthMetadata(PropertyMetadata maxLengthMetadata)
```
    setMaxLengthMetadata.
  - mergeField
```
public Ssn mergeField(MergeField mergeField)
```
    mergeField.
    
    Returns:
    
    Ssn
  - getMergeField
```
public MergeField getMergeField()
```
    Contains the information necessary to map the tab to a field in SalesForce..
    
    Returns:
    
    mergeField
  - setMergeField
```
public void setMergeField(MergeField mergeField)
```
    setMergeField.
  - mergeFieldXml
```
public Ssn mergeFieldXml(String mergeFieldXml)
```
    mergeFieldXml.
    
    Returns:
    
    Ssn
  - getMergeFieldXml
```
public String getMergeFieldXml()
```
    .
    
    Returns:
    
    mergeFieldXml
  - setMergeFieldXml
```
public void setMergeFieldXml(String mergeFieldXml)
```
    setMergeFieldXml.
  - name
```
public Ssn name(String name)
```
    name.
    
    Returns:
    
    Ssn
  - getName
```
public String getName()
```
    Specifies the tool tip text for the tab..
    
    Returns:
    
    name
  - setName
```
public void setName(String name)
```
    setName.
  - nameMetadata
```
public Ssn nameMetadata(PropertyMetadata nameMetadata)
```
    nameMetadata.
    
    Returns:
    
    Ssn
  - getNameMetadata
```
public PropertyMetadata getNameMetadata()
```
    Metadata that indicates whether the `name` property is editable. This property is read-only..
    
    Returns:
    
    nameMetadata
  - setNameMetadata
```
public void setNameMetadata(PropertyMetadata nameMetadata)
```
    setNameMetadata.
  - originalValue
```
public Ssn originalValue(String originalValue)
```
    originalValue.
    
    Returns:
    
    Ssn
  - getOriginalValue
```
public String getOriginalValue()
```
    The initial value of the tab when it was sent to the recipient. .
    
    Returns:
    
    originalValue
  - setOriginalValue
```
public void setOriginalValue(String originalValue)
```
    setOriginalValue.
  - originalValueMetadata
```
public Ssn originalValueMetadata(PropertyMetadata originalValueMetadata)
```
    originalValueMetadata.
    
    Returns:
    
    Ssn
  - getOriginalValueMetadata
```
public PropertyMetadata getOriginalValueMetadata()
```
    Metadata that indicates whether the `originalValue` property is editable..
    
    Returns:
    
    originalValueMetadata
  - setOriginalValueMetadata
```
public void setOriginalValueMetadata(PropertyMetadata originalValueMetadata)
```
    setOriginalValueMetadata.
  - pageNumber
```
public Ssn pageNumber(String pageNumber)
```
    pageNumber.
    
    Returns:
    
    Ssn
  - getPageNumber
```
public String getPageNumber()
```
    Specifies the page number on which the tab is located..
    
    Returns:
    
    pageNumber
  - setPageNumber
```
public void setPageNumber(String pageNumber)
```
    setPageNumber.
  - pageNumberMetadata
```
public Ssn pageNumberMetadata(PropertyMetadata pageNumberMetadata)
```
    pageNumberMetadata.
    
    Returns:
    
    Ssn
  - getPageNumberMetadata
```
public PropertyMetadata getPageNumberMetadata()
```
    Metadata that indicates whether the `pageNumber` property is editable..
    
    Returns:
    
    pageNumberMetadata
  - setPageNumberMetadata
```
public void setPageNumberMetadata(PropertyMetadata pageNumberMetadata)
```
    setPageNumberMetadata.
  - recipientId
```
public Ssn recipientId(String recipientId)
```
    recipientId.
    
    Returns:
    
    Ssn
  - 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)
```
    setRecipientId.
  - recipientIdGuid
```
public Ssn recipientIdGuid(String recipientIdGuid)
```
    recipientIdGuid.
    
    Returns:
    
    Ssn
  - getRecipientIdGuid
```
public String getRecipientIdGuid()
```
    .
    
    Returns:
    
    recipientIdGuid
  - setRecipientIdGuid
```
public void setRecipientIdGuid(String recipientIdGuid)
```
    setRecipientIdGuid.
  - recipientIdGuidMetadata
```
public Ssn recipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
```
    recipientIdGuidMetadata.
    
    Returns:
    
    Ssn
  - getRecipientIdGuidMetadata
```
public PropertyMetadata getRecipientIdGuidMetadata()
```
    Metadata that indicates whether the `recipientIdGuid` property is editable..
    
    Returns:
    
    recipientIdGuidMetadata
  - setRecipientIdGuidMetadata
```
public void setRecipientIdGuidMetadata(PropertyMetadata recipientIdGuidMetadata)
```
    setRecipientIdGuidMetadata.
  - recipientIdMetadata
```
public Ssn recipientIdMetadata(PropertyMetadata recipientIdMetadata)
```
    recipientIdMetadata.
    
    Returns:
    
    Ssn
  - getRecipientIdMetadata
```
public PropertyMetadata getRecipientIdMetadata()
```
    Metadata that indicates whether the `recipientId` property is editable..
    
    Returns:
    
    recipientIdMetadata
  - setRecipientIdMetadata
```
public void setRecipientIdMetadata(PropertyMetadata recipientIdMetadata)
```
    setRecipientIdMetadata.
  - requireAll
```
public Ssn requireAll(String requireAll)
```
    requireAll.
    
    Returns:
    
    Ssn
  - 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)
```
    setRequireAll.
  - requireAllMetadata
```
public Ssn requireAllMetadata(PropertyMetadata requireAllMetadata)
```
    requireAllMetadata.
    
    Returns:
    
    Ssn
  - getRequireAllMetadata
```
public PropertyMetadata getRequireAllMetadata()
```
    Metadata that indicates whether the `requireAll` property is editable..
    
    Returns:
    
    requireAllMetadata
  - setRequireAllMetadata
```
public void setRequireAllMetadata(PropertyMetadata requireAllMetadata)
```
    setRequireAllMetadata.
  - required
```
public Ssn required(String required)
```
    required.
    
    Returns:
    
    Ssn
  - 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)
```
    setRequired.
  - requiredMetadata
```
public Ssn requiredMetadata(PropertyMetadata requiredMetadata)
```
    requiredMetadata.
    
    Returns:
    
    Ssn
  - getRequiredMetadata
```
public PropertyMetadata getRequiredMetadata()
```
    Metadata that indicates whether the `required` property is editable..
    
    Returns:
    
    requiredMetadata
  - setRequiredMetadata
```
public void setRequiredMetadata(PropertyMetadata requiredMetadata)
```
    setRequiredMetadata.
  - requireInitialOnSharedChange
```
public Ssn requireInitialOnSharedChange(String requireInitialOnSharedChange)
```
    requireInitialOnSharedChange.
    
    Returns:
    
    Ssn
  - 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)
```
    setRequireInitialOnSharedChange.
  - requireInitialOnSharedChangeMetadata
```
public Ssn requireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
```
    requireInitialOnSharedChangeMetadata.
    
    Returns:
    
    Ssn
  - getRequireInitialOnSharedChangeMetadata
```
public PropertyMetadata getRequireInitialOnSharedChangeMetadata()
```
    Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
    
    Returns:
    
    requireInitialOnSharedChangeMetadata
  - setRequireInitialOnSharedChangeMetadata
```
public void setRequireInitialOnSharedChangeMetadata(PropertyMetadata requireInitialOnSharedChangeMetadata)
```
    setRequireInitialOnSharedChangeMetadata.
  - senderRequired
```
public Ssn senderRequired(String senderRequired)
```
    senderRequired.
    
    Returns:
    
    Ssn
  - 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)
```
    setSenderRequired.
  - senderRequiredMetadata
```
public Ssn senderRequiredMetadata(PropertyMetadata senderRequiredMetadata)
```
    senderRequiredMetadata.
    
    Returns:
    
    Ssn
  - getSenderRequiredMetadata
```
public PropertyMetadata getSenderRequiredMetadata()
```
    Metadata that indicates whether the `senderRequired` property is editable..
    
    Returns:
    
    senderRequiredMetadata
  - setSenderRequiredMetadata
```
public void setSenderRequiredMetadata(PropertyMetadata senderRequiredMetadata)
```
    setSenderRequiredMetadata.
  - shared
```
public Ssn shared(String shared)
```
    shared.
    
    Returns:
    
    Ssn
  - getShared
```
public String getShared()
```
    When set to **true**, this custom tab is shared..
    
    Returns:
    
    shared
  - setShared
```
public void setShared(String shared)
```
    setShared.
  - sharedMetadata
```
public Ssn sharedMetadata(PropertyMetadata sharedMetadata)
```
    sharedMetadata.
    
    Returns:
    
    Ssn
  - getSharedMetadata
```
public PropertyMetadata getSharedMetadata()
```
    Metadata that indicates whether the `shared` property is editable..
    
    Returns:
    
    sharedMetadata
  - setSharedMetadata
```
public void setSharedMetadata(PropertyMetadata sharedMetadata)
```
    setSharedMetadata.
  - shareToRecipients
```
public Ssn shareToRecipients(String shareToRecipients)
```
    shareToRecipients.
    
    Returns:
    
    Ssn
  - getShareToRecipients
```
public String getShareToRecipients()
```
    .
    
    Returns:
    
    shareToRecipients
  - setShareToRecipients
```
public void setShareToRecipients(String shareToRecipients)
```
    setShareToRecipients.
  - shareToRecipientsMetadata
```
public Ssn shareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)
```
    shareToRecipientsMetadata.
    
    Returns:
    
    Ssn
  - getShareToRecipientsMetadata
```
public PropertyMetadata getShareToRecipientsMetadata()
```
    Reserved for DocuSign..
    
    Returns:
    
    shareToRecipientsMetadata
  - setShareToRecipientsMetadata
```
public void setShareToRecipientsMetadata(PropertyMetadata shareToRecipientsMetadata)
```
    setShareToRecipientsMetadata.
  - smartContractInformation
```
public Ssn smartContractInformation(SmartContractInformation smartContractInformation)
```
    smartContractInformation.
    
    Returns:
    
    Ssn
  - getSmartContractInformation
```
public SmartContractInformation getSmartContractInformation()
```
    Reserved for DocuSign..
    
    Returns:
    
    smartContractInformation
  - setSmartContractInformation
```
public void setSmartContractInformation(SmartContractInformation smartContractInformation)
```
    setSmartContractInformation.
  - source
```
public Ssn source(String source)
```
    source.
    
    Returns:
    
    Ssn
  - getSource
```
public String getSource()
```
    .
    
    Returns:
    
    source
  - setSource
```
public void setSource(String source)
```
    setSource.
  - status
```
public Ssn status(String status)
```
    status.
    
    Returns:
    
    Ssn
  - 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)
```
    setStatus.
  - statusMetadata
```
public Ssn statusMetadata(PropertyMetadata statusMetadata)
```
    statusMetadata.
    
    Returns:
    
    Ssn
  - getStatusMetadata
```
public PropertyMetadata getStatusMetadata()
```
    Metadata that indicates whether the `status` property is editable..
    
    Returns:
    
    statusMetadata
  - setStatusMetadata
```
public void setStatusMetadata(PropertyMetadata statusMetadata)
```
    setStatusMetadata.
  - tabGroupLabels
```
public Ssn tabGroupLabels(List<String> tabGroupLabels)
```
    tabGroupLabels.
    
    Returns:
    
    Ssn
  - addTabGroupLabelsItem
```
public Ssn addTabGroupLabelsItem(String tabGroupLabelsItem)
```
    addTabGroupLabelsItem.
    
    Returns:
    
    Ssn
  - getTabGroupLabels
```
public List<String> getTabGroupLabels()
```
    .
    
    Returns:
    
    tabGroupLabels
  - setTabGroupLabels
```
public void setTabGroupLabels(List<String> tabGroupLabels)
```
    setTabGroupLabels.
  - tabGroupLabelsMetadata
```
public Ssn tabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
```
    tabGroupLabelsMetadata.
    
    Returns:
    
    Ssn
  - getTabGroupLabelsMetadata
```
public PropertyMetadata getTabGroupLabelsMetadata()
```
    Metadata that indicates whether the `tabGroupLabels` property is editable..
    
    Returns:
    
    tabGroupLabelsMetadata
  - setTabGroupLabelsMetadata
```
public void setTabGroupLabelsMetadata(PropertyMetadata tabGroupLabelsMetadata)
```
    setTabGroupLabelsMetadata.
  - tabId
```
public Ssn tabId(String tabId)
```
    tabId.
    
    Returns:
    
    Ssn
  - 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)
```
    setTabId.
  - tabIdMetadata
```
public Ssn tabIdMetadata(PropertyMetadata tabIdMetadata)
```
    tabIdMetadata.
    
    Returns:
    
    Ssn
  - getTabIdMetadata
```
public PropertyMetadata getTabIdMetadata()
```
    Metadata that indicates whether the `tabId` property is editable..
    
    Returns:
    
    tabIdMetadata
  - setTabIdMetadata
```
public void setTabIdMetadata(PropertyMetadata tabIdMetadata)
```
    setTabIdMetadata.
  - tabLabel
```
public Ssn tabLabel(String tabLabel)
```
    tabLabel.
    
    Returns:
    
    Ssn
  - getTabLabel
```
public String getTabLabel()
```
    The label string associated with the tab..
    
    Returns:
    
    tabLabel
  - setTabLabel
```
public void setTabLabel(String tabLabel)
```
    setTabLabel.
  - tabLabelMetadata
```
public Ssn tabLabelMetadata(PropertyMetadata tabLabelMetadata)
```
    tabLabelMetadata.
    
    Returns:
    
    Ssn
  - getTabLabelMetadata
```
public PropertyMetadata getTabLabelMetadata()
```
    Metadata that indicates whether the `tabLabel` property is editable..
    
    Returns:
    
    tabLabelMetadata
  - setTabLabelMetadata
```
public void setTabLabelMetadata(PropertyMetadata tabLabelMetadata)
```
    setTabLabelMetadata.
  - tabOrder
```
public Ssn tabOrder(String tabOrder)
```
    tabOrder.
    
    Returns:
    
    Ssn
  - getTabOrder
```
public String getTabOrder()
```
    .
    
    Returns:
    
    tabOrder
  - setTabOrder
```
public void setTabOrder(String tabOrder)
```
    setTabOrder.
  - tabOrderMetadata
```
public Ssn tabOrderMetadata(PropertyMetadata tabOrderMetadata)
```
    tabOrderMetadata.
    
    Returns:
    
    Ssn
  - getTabOrderMetadata
```
public PropertyMetadata getTabOrderMetadata()
```
    Metadata that indicates whether the `tabOrder` property is editable..
    
    Returns:
    
    tabOrderMetadata
  - setTabOrderMetadata
```
public void setTabOrderMetadata(PropertyMetadata tabOrderMetadata)
```
    setTabOrderMetadata.
  - tabType
```
public Ssn tabType(String tabType)
```
    tabType.
    
    Returns:
    
    Ssn
  - getTabType
```
public String getTabType()
```
    .
    
    Returns:
    
    tabType
  - setTabType
```
public void setTabType(String tabType)
```
    setTabType.
  - tabTypeMetadata
```
public Ssn tabTypeMetadata(PropertyMetadata tabTypeMetadata)
```
    tabTypeMetadata.
    
    Returns:
    
    Ssn
  - getTabTypeMetadata
```
public PropertyMetadata getTabTypeMetadata()
```
    Metadata that indicates whether the `tabType` property is editable..
    
    Returns:
    
    tabTypeMetadata
  - setTabTypeMetadata
```
public void setTabTypeMetadata(PropertyMetadata tabTypeMetadata)
```
    setTabTypeMetadata.
  - templateLocked
```
public Ssn templateLocked(String templateLocked)
```
    templateLocked.
    
    Returns:
    
    Ssn
  - 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)
```
    setTemplateLocked.
  - templateLockedMetadata
```
public Ssn templateLockedMetadata(PropertyMetadata templateLockedMetadata)
```
    templateLockedMetadata.
    
    Returns:
    
    Ssn
  - getTemplateLockedMetadata
```
public PropertyMetadata getTemplateLockedMetadata()
```
    Metadata that indicates whether the `templateLocked` property is editable..
    
    Returns:
    
    templateLockedMetadata
  - setTemplateLockedMetadata
```
public void setTemplateLockedMetadata(PropertyMetadata templateLockedMetadata)
```
    setTemplateLockedMetadata.
  - templateRequired
```
public Ssn templateRequired(String templateRequired)
```
    templateRequired.
    
    Returns:
    
    Ssn
  - 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)
```
    setTemplateRequired.
  - templateRequiredMetadata
```
public Ssn templateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
```
    templateRequiredMetadata.
    
    Returns:
    
    Ssn
  - getTemplateRequiredMetadata
```
public PropertyMetadata getTemplateRequiredMetadata()
```
    Metadata that indicates whether the `templateRequired` property is editable..
    
    Returns:
    
    templateRequiredMetadata
  - setTemplateRequiredMetadata
```
public void setTemplateRequiredMetadata(PropertyMetadata templateRequiredMetadata)
```
    setTemplateRequiredMetadata.
  - tooltip
```
public Ssn tooltip(String tooltip)
```
    tooltip.
    
    Returns:
    
    Ssn
  - getTooltip
```
public String getTooltip()
```
    .
    
    Returns:
    
    tooltip
  - setTooltip
```
public void setTooltip(String tooltip)
```
    setTooltip.
  - toolTipMetadata
```
public Ssn toolTipMetadata(PropertyMetadata toolTipMetadata)
```
    toolTipMetadata.
    
    Returns:
    
    Ssn
  - getToolTipMetadata
```
public PropertyMetadata getToolTipMetadata()
```
    Metadata that indicates whether the `toolTip` property is editable..
    
    Returns:
    
    toolTipMetadata
  - setToolTipMetadata
```
public void setToolTipMetadata(PropertyMetadata toolTipMetadata)
```
    setToolTipMetadata.
  - underline
```
public Ssn underline(String underline)
```
    underline.
    
    Returns:
    
    Ssn
  - getUnderline
```
public String getUnderline()
```
    When set to **true**, the information in the tab is underlined..
    
    Returns:
    
    underline
  - setUnderline
```
public void setUnderline(String underline)
```
    setUnderline.
  - underlineMetadata
```
public Ssn underlineMetadata(PropertyMetadata underlineMetadata)
```
    underlineMetadata.
    
    Returns:
    
    Ssn
  - getUnderlineMetadata
```
public PropertyMetadata getUnderlineMetadata()
```
    Metadata that indicates whether the `underline` property is editable..
    
    Returns:
    
    underlineMetadata
  - setUnderlineMetadata
```
public void setUnderlineMetadata(PropertyMetadata underlineMetadata)
```
    setUnderlineMetadata.
  - validationMessage
```
public Ssn validationMessage(String validationMessage)
```
    validationMessage.
    
    Returns:
    
    Ssn
  - getValidationMessage
```
public String getValidationMessage()
```
    The message displayed if the custom tab fails input validation (either custom of embedded)..
    
    Returns:
    
    validationMessage
  - setValidationMessage
```
public void setValidationMessage(String validationMessage)
```
    setValidationMessage.
  - validationMessageMetadata
```
public Ssn validationMessageMetadata(PropertyMetadata validationMessageMetadata)
```
    validationMessageMetadata.
    
    Returns:
    
    Ssn
  - getValidationMessageMetadata
```
public PropertyMetadata getValidationMessageMetadata()
```
    Metadata that indicates whether the `validationMessage` property is editable..
    
    Returns:
    
    validationMessageMetadata
  - setValidationMessageMetadata
```
public void setValidationMessageMetadata(PropertyMetadata validationMessageMetadata)
```
    setValidationMessageMetadata.
  - validationPattern
```
public Ssn validationPattern(String validationPattern)
```
    validationPattern.
    
    Returns:
    
    Ssn
  - getValidationPattern
```
public String getValidationPattern()
```
    A regular expression used to validate input for the tab..
    
    Returns:
    
    validationPattern
  - setValidationPattern
```
public void setValidationPattern(String validationPattern)
```
    setValidationPattern.
  - validationPatternMetadata
```
public Ssn validationPatternMetadata(PropertyMetadata validationPatternMetadata)
```
    validationPatternMetadata.
    
    Returns:
    
    Ssn
  - getValidationPatternMetadata
```
public PropertyMetadata getValidationPatternMetadata()
```
    Metadata that indicates whether the `validationPattern` property is editable..
    
    Returns:
    
    validationPatternMetadata
  - setValidationPatternMetadata
```
public void setValidationPatternMetadata(PropertyMetadata validationPatternMetadata)
```
    setValidationPatternMetadata.
  - value
```
public Ssn value(String value)
```
    value.
    
    Returns:
    
    Ssn
  - getValue
```
public String getValue()
```
    Specifies the value of the tab. .
    
    Returns:
    
    value
  - setValue
```
public void setValue(String value)
```
    setValue.
  - valueMetadata
```
public Ssn valueMetadata(PropertyMetadata valueMetadata)
```
    valueMetadata.
    
    Returns:
    
    Ssn
  - getValueMetadata
```
public PropertyMetadata getValueMetadata()
```
    Metadata that indicates whether the `value` property is editable..
    
    Returns:
    
    valueMetadata
  - setValueMetadata
```
public void setValueMetadata(PropertyMetadata valueMetadata)
```
    setValueMetadata.
  - width
```
public Ssn width(String width)
```
    width.
    
    Returns:
    
    Ssn
  - getWidth
```
public String getWidth()
```
    Width of the tab in pixels..
    
    Returns:
    
    width
  - setWidth
```
public void setWidth(String width)
```
    setWidth.
  - widthMetadata
```
public Ssn widthMetadata(PropertyMetadata widthMetadata)
```
    widthMetadata.
    
    Returns:
    
    Ssn
  - getWidthMetadata
```
public PropertyMetadata getWidthMetadata()
```
    Metadata that indicates whether the `width` property is editable..
    
    Returns:
    
    widthMetadata
  - setWidthMetadata
```
public void setWidthMetadata(PropertyMetadata widthMetadata)
```
    setWidthMetadata.
  - xPosition
```
public Ssn xPosition(String xPosition)
```
    xPosition.
    
    Returns:
    
    Ssn
  - 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)
```
    setXPosition.
  - xPositionMetadata
```
public Ssn xPositionMetadata(PropertyMetadata xPositionMetadata)
```
    xPositionMetadata.
    
    Returns:
    
    Ssn
  - getXPositionMetadata
```
public PropertyMetadata getXPositionMetadata()
```
    Metadata that indicates whether the `xPosition` property is editable..
    
    Returns:
    
    xPositionMetadata
  - setXPositionMetadata
```
public void setXPositionMetadata(PropertyMetadata xPositionMetadata)
```
    setXPositionMetadata.
  - yPosition
```
public Ssn yPosition(String yPosition)
```
    yPosition.
    
    Returns:
    
    Ssn
  - 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)
```
    setYPosition.
  - yPositionMetadata
```
public Ssn yPositionMetadata(PropertyMetadata yPositionMetadata)
```
    yPositionMetadata.
    
    Returns:
    
    Ssn
  - getYPositionMetadata
```
public PropertyMetadata getYPositionMetadata()
```
    Metadata that indicates whether the `yPosition` property is editable..
    
    Returns:
    
    yPositionMetadata
  - setYPositionMetadata
```
public void setYPositionMetadata(PropertyMetadata yPositionMetadata)
```
    setYPositionMetadata.
  - equals
```
public boolean equals(Object o)
```
    Compares objects.
    
    Overrides:
    
    equals in class Object
    
    Returns:
    
    true or false depending on comparison result.
  - hashCode
```
public int hashCode()
```
    Returns the HashCode.
    
    Overrides:
    
    hashCode in class Object
  - toString
```
public String toString()
```
    Converts the given object to string.
    
    Overrides:
    
    toString in class Object

Class Ssn

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

Ssn

Method Detail

anchorAllowWhiteSpaceInCharacters

getAnchorAllowWhiteSpaceInCharacters

setAnchorAllowWhiteSpaceInCharacters

anchorAllowWhiteSpaceInCharactersMetadata

getAnchorAllowWhiteSpaceInCharactersMetadata

setAnchorAllowWhiteSpaceInCharactersMetadata

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

caption

getCaption

setCaption

captionMetadata

getCaptionMetadata

setCaptionMetadata

concealValueOnDocument