Uses of Class
com.docusign.esign.model.Ssn

Packages that use Ssn

Package	Description
com.docusign.esign.model

Uses of Ssn in com.docusign.esign.model

Methods in com.docusign.esign.model that return Ssn

Modifier and Type	Method and Description
Ssn	Ssn.anchorCaseSensitive(String anchorCaseSensitive) When set to **true**, the anchor string does not consider case when matching strings in the document.
Ssn	Ssn.anchorHorizontalAlignment(String anchorHorizontalAlignment) Specifies the alignment of anchor tabs with anchor strings.
Ssn	Ssn.anchorIgnoreIfNotPresent(String anchorIgnoreIfNotPresent) When set to **true**, this tab is ignored if anchorString is not found in the document.
Ssn	Ssn.anchorMatchWholeWord(String anchorMatchWholeWord) 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**.
Ssn	Ssn.anchorString(String anchorString) Anchor text information for a radio button.
Ssn	Ssn.anchorUnits(String anchorUnits) Specifies units of the X and Y offset.
Ssn	Ssn.anchorXOffset(String anchorXOffset) Specifies the X axis location of the tab, in achorUnits, relative to the anchorString.
Ssn	Ssn.anchorYOffset(String anchorYOffset) Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString.
Ssn	Ssn.bold(String bold) When set to **true**, the information in the tab is bold.
Ssn	Ssn.concealValueOnDocument(String concealValueOnDocument) 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.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.
Ssn	Ssn.conditionalParentLabel(String conditionalParentLabel) For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
Ssn	Ssn.conditionalParentValue(String conditionalParentValue) For conditional fields, this is the value of the parent tab that controls the tab's visibility.\n\nIf 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.\n
Ssn	Ssn.customTabId(String customTabId) The DocuSign generated custom tab ID for the custom tab to be applied.
Ssn	Ssn.disableAutoSize(String disableAutoSize) When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data.
Ssn	Ssn.documentId(String documentId) Specifies the document ID number that the tab is placed on.
Ssn	Ssn.errorDetails(ErrorDetails errorDetails)
Ssn	Ssn.font(String font) The font to be used for the tab value.
Ssn	Ssn.fontColor(String fontColor) The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
Ssn	Ssn.fontSize(String fontSize) The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72.
Ssn	Ssn.italic(String italic) When set to **true**, the information in the tab is italic.
Ssn	Ssn.locked(String locked) When set to **true**, the signer cannot change the data of the custom tab.
Ssn	Ssn.maxLength(Integer maxLength) An optional value that describes the maximum length of the property when the property is a string.
Ssn	Ssn.mergeField(MergeField mergeField)
Ssn	Ssn.name(String name) Specifies the tool tip text for the tab.
Ssn	Ssn.originalValue(String originalValue) The initial value of the tab when it was sent to the recipient.
Ssn	Ssn.pageNumber(String pageNumber) Specifies the page number on which the tab is located.
Ssn	Ssn.recipientId(String recipientId) Unique for the recipient.
Ssn	Ssn.requireAll(String requireAll) When set to **true** and shared is true, information must be entered in this field to complete the envelope.
Ssn	Ssn.required(String required) When set to **true**, the signer is required to fill out this tab
Ssn	Ssn.requireInitialOnSharedChange(String requireInitialOnSharedChange) Optional element for field markup.
Ssn	Ssn.senderRequired(String senderRequired) When set to **true**, the sender must populate the tab before an envelope can be sent using the template.
Ssn	Ssn.shared(String shared) When set to **true**, this custom tab is shared.
Ssn	Ssn.status(String status) Indicates the envelope status.
Ssn	Ssn.tabId(String tabId) The unique identifier for the tab.
Ssn	Ssn.tabLabel(String tabLabel) The label string associated with the tab.
Ssn	Ssn.templateLocked(String templateLocked) When set to **true**, the sender cannot change any attributes of the recipient.
Ssn	Ssn.templateRequired(String templateRequired) When set to **true**, the sender may not remove the recipient.
Ssn	Ssn.underline(String underline) When set to **true**, the information in the tab is underlined.
Ssn	Ssn.validationMessage(String validationMessage) The message displayed if the custom tab fails input validation (either custom of embedded).
Ssn	Ssn.validationPattern(String validationPattern) A regular expressionn used to validate input for the tab.
Ssn	Ssn.value(String value) Specifies the value of the tab.
Ssn	Ssn.width(Integer width) Width of the tab in pixels.
Ssn	Ssn.xPosition(String xPosition) This indicates the horizontal offset of the object on the page.
Ssn	Ssn.yPosition(String yPosition) This indicates the vertical offset of the object on the page.

Methods in com.docusign.esign.model that return types with arguments of type Ssn

Modifier and Type	Method and Description
List<Ssn>	TemplateTabs.getSsnTabs()
List<Ssn>	Tabs.getSsnTabs()

Method parameters in com.docusign.esign.model with type arguments of type Ssn

Modifier and Type	Method and Description
void	TemplateTabs.setSsnTabs(List<Ssn> ssnTabs)
void	Tabs.setSsnTabs(List<Ssn> ssnTabs)
TemplateTabs	TemplateTabs.ssnTabs(List<Ssn> ssnTabs) Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN).
Tabs	Tabs.ssnTabs(List<Ssn> ssnTabs) Specifies a tag on the document where you want the recipient to enter a Social Security Number (SSN).