Docusign CSharp Docs
|
A tab that allows the recipient to select a yes/no (on/off) option. More...
Properties | |
string | AnchorAllowWhiteSpaceInCharacters [get, set] |
Gets or Sets AnchorAllowWhiteSpaceInCharacters More... | |
PropertyMetadata | AnchorAllowWhiteSpaceInCharactersMetadata [get, set] |
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable. More... | |
string | AnchorCaseSensitive [get, set] |
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true. More... | |
PropertyMetadata | AnchorCaseSensitiveMetadata [get, set] |
Metadata that indicates whether the `anchorCaseSensitive` property is editable. More... | |
string | AnchorHorizontalAlignment [get, set] |
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left. More... | |
PropertyMetadata | AnchorHorizontalAlignmentMetadata [get, set] |
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable. More... | |
string | AnchorIgnoreIfNotPresent [get, set] |
When set to true, this tab is ignored if anchorString is not found in the document. More... | |
PropertyMetadata | AnchorIgnoreIfNotPresentMetadata [get, set] |
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable. More... | |
string | AnchorMatchWholeWord [get, set] |
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. More... | |
PropertyMetadata | AnchorMatchWholeWordMetadata [get, set] |
Metadata that indicates whether the `anchorMatchWholeWord` property is editable. More... | |
string | AnchorString [get, set] |
Anchor text information for a radio button. More... | |
PropertyMetadata | AnchorStringMetadata [get, set] |
Metadata that indicates whether the `anchorString` property is editable. More... | |
string | AnchorTabProcessorVersion [get, set] |
Gets or Sets AnchorTabProcessorVersion More... | |
PropertyMetadata | AnchorTabProcessorVersionMetadata [get, set] |
Reserved for DocuSign. More... | |
string | AnchorUnits [get, set] |
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. More... | |
PropertyMetadata | AnchorUnitsMetadata [get, set] |
Metadata that indicates whether the `anchorUnits` property is editable. More... | |
string | AnchorXOffset [get, set] |
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. More... | |
PropertyMetadata | AnchorXOffsetMetadata [get, set] |
Metadata that indicates whether the `anchorXOffset` property is editable. More... | |
string | AnchorYOffset [get, set] |
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. More... | |
PropertyMetadata | AnchorYOffsetMetadata [get, set] |
Metadata that indicates whether the `anchorYOffset` property is editable. More... | |
string | Bold [get, set] |
When set to true, the information in the tab is bold. More... | |
PropertyMetadata | BoldMetadata [get, set] |
Metadata that indicates whether the `bold` property is editable. More... | |
string | Caption [get, set] |
Gets or Sets Caption More... | |
PropertyMetadata | CaptionMetadata [get, set] |
Gets or Sets CaptionMetadata More... | |
string | ConditionalParentLabel [get, set] |
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. More... | |
PropertyMetadata | ConditionalParentLabelMetadata [get, set] |
Metadata that indicates whether the `conditionalParentLabel` property is editable. More... | |
string | ConditionalParentValue [get, set] |
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. More... | |
PropertyMetadata | ConditionalParentValueMetadata [get, set] |
Metadata that indicates whether the `conditionalParentValue` property is editable. More... | |
string | CustomTabId [get, set] |
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. More... | |
PropertyMetadata | CustomTabIdMetadata [get, set] |
Metadata that indicates whether the `customTabId` property is editable. More... | |
string | DocumentId [get, set] |
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. More... | |
PropertyMetadata | DocumentIdMetadata [get, set] |
Metadata that indicates whether the `documentId` property is editable. More... | |
ErrorDetails | ErrorDetails [get, set] |
Array or errors. More... | |
string | Font [get, set] |
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. More... | |
string | FontColor [get, set] |
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. More... | |
PropertyMetadata | FontColorMetadata [get, set] |
Metadata that indicates whether the `fontColor` property is editable. More... | |
PropertyMetadata | FontMetadata [get, set] |
Metadata that indicates whether the `font` property is editable. More... | |
string | FontSize [get, set] |
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. More... | |
PropertyMetadata | FontSizeMetadata [get, set] |
Metadata that indicates whether the `fontSize` property is editable. More... | |
string | FormOrder [get, set] |
Gets or Sets FormOrder More... | |
PropertyMetadata | FormOrderMetadata [get, set] |
Metadata that indicates whether the `formOrder` property is editable. More... | |
string | FormPageLabel [get, set] |
Gets or Sets FormPageLabel More... | |
PropertyMetadata | FormPageLabelMetadata [get, set] |
Metadata that indicates whether the `formPageLabel` property is editable. More... | |
string | FormPageNumber [get, set] |
Gets or Sets FormPageNumber More... | |
PropertyMetadata | FormPageNumberMetadata [get, set] |
Metadata that indicates whether the `fromPageNumber` property is editable. More... | |
string | Height [get, set] |
Height of the tab in pixels. More... | |
PropertyMetadata | HeightMetadata [get, set] |
Metadata that indicates whether the `height` property is editable. More... | |
string | Italic [get, set] |
When set to true, the information in the tab is italic. More... | |
PropertyMetadata | ItalicMetadata [get, set] |
Metadata that indicates whether the `italic` property is editable. More... | |
string | Locked [get, set] |
When set to true, the signer cannot change the data of the custom tab. More... | |
PropertyMetadata | LockedMetadata [get, set] |
Metadata that indicates whether the `locked` property is editable. More... | |
MergeField | MergeField [get, set] |
Contains the information necessary to map the tab to a field in SalesForce. More... | |
string | MergeFieldXml [get, set] |
Gets or Sets MergeFieldXml More... | |
string | Name [get, set] |
Specifies the tool tip text for the tab. More... | |
PropertyMetadata | NameMetadata [get, set] |
Metadata that indicates whether the `name` property is editable. This property is read-only. More... | |
string | PageNumber [get, set] |
Specifies the page number on which the tab is located. More... | |
PropertyMetadata | PageNumberMetadata [get, set] |
Metadata that indicates whether the `pageNumber` property is editable. More... | |
string | RecipientId [get, set] |
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. More... | |
string | RecipientIdGuid [get, set] |
Gets or Sets RecipientIdGuid More... | |
PropertyMetadata | RecipientIdGuidMetadata [get, set] |
Metadata that indicates whether the `recipientIdGuid` property is editable. More... | |
PropertyMetadata | RecipientIdMetadata [get, set] |
Metadata that indicates whether the `recipientId` property is editable. More... | |
string | Required [get, set] |
When set to true, the signer is required to fill out this tab More... | |
PropertyMetadata | RequiredMetadata [get, set] |
Metadata that indicates whether the `required` property is editable. More... | |
string | RequireInitialOnSharedChange [get, set] |
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. More... | |
PropertyMetadata | RequireInitialOnSharedChangeMetadata [get, set] |
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. More... | |
string | Selected [get, set] |
When set to true, the checkbox is selected. More... | |
PropertyMetadata | SelectedMetadata [get, set] |
Metadata that indicates whether the `selected` property is editable. More... | |
string | SelectedOriginal [get, set] |
Gets or Sets SelectedOriginal More... | |
PropertyMetadata | SelectedOriginalMetadata [get, set] |
Gets or Sets SelectedOriginalMetadata More... | |
string | Shared [get, set] |
When set to true, this custom tab is shared. More... | |
PropertyMetadata | SharedMetadata [get, set] |
Metadata that indicates whether the `shared` property is editable. More... | |
string | ShareToRecipients [get, set] |
Gets or Sets ShareToRecipients More... | |
PropertyMetadata | ShareToRecipientsMetadata [get, set] |
Reserved for DocuSign. More... | |
SmartContractInformation | SmartContractInformation [get, set] |
Reserved for DocuSign. More... | |
string | Source [get, set] |
Gets or Sets Source More... | |
string | Status [get, set] |
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. More... | |
PropertyMetadata | StatusMetadata [get, set] |
Metadata that indicates whether the `status` property is editable. More... | |
List< string > | TabGroupLabels [get, set] |
Gets or Sets TabGroupLabels More... | |
PropertyMetadata | TabGroupLabelsMetadata [get, set] |
Metadata that indicates whether the `tabGroupLabels` property is editable. More... | |
string | TabId [get, set] |
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. More... | |
PropertyMetadata | TabIdMetadata [get, set] |
Metadata that indicates whether the `tabId` property is editable. More... | |
string | TabLabel [get, set] |
The label string associated with the tab. More... | |
PropertyMetadata | TabLabelMetadata [get, set] |
Metadata that indicates whether the `tabLabel` property is editable. More... | |
string | TabOrder [get, set] |
Gets or Sets TabOrder More... | |
PropertyMetadata | TabOrderMetadata [get, set] |
Metadata that indicates whether the `tabOrder` property is editable. More... | |
string | TabType [get, set] |
Gets or Sets TabType More... | |
PropertyMetadata | TabTypeMetadata [get, set] |
Metadata that indicates whether the `tabType` property is editable. More... | |
string | TemplateLocked [get, set] |
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. More... | |
PropertyMetadata | TemplateLockedMetadata [get, set] |
Metadata that indicates whether the `templateLocked` property is editable. More... | |
string | TemplateRequired [get, set] |
When set to true, the sender may not remove the recipient. Used only when working with template recipients. More... | |
PropertyMetadata | TemplateRequiredMetadata [get, set] |
Metadata that indicates whether the `templateRequired` property is editable. More... | |
string | Tooltip [get, set] |
Gets or Sets Tooltip More... | |
PropertyMetadata | ToolTipMetadata [get, set] |
Metadata that indicates whether the `toolTip` property is editable. More... | |
string | Underline [get, set] |
When set to true, the information in the tab is underlined. More... | |
PropertyMetadata | UnderlineMetadata [get, set] |
Metadata that indicates whether the `underline` property is editable. More... | |
string | Width [get, set] |
Width of the tab in pixels. More... | |
PropertyMetadata | WidthMetadata [get, set] |
Metadata that indicates whether the `width` property is editable. More... | |
string | XPosition [get, set] |
This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. More... | |
PropertyMetadata | XPositionMetadata [get, set] |
Metadata that indicates whether the `xPosition` property is editable. More... | |
string | YPosition [get, set] |
This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. More... | |
PropertyMetadata | YPositionMetadata [get, set] |
Metadata that indicates whether the `yPosition` property is editable. More... | |
A tab that allows the recipient to select a yes/no (on/off) option.
|
inline |
Initializes a new instance of the Checkbox class.
AnchorAllowWhiteSpaceInCharacters | AnchorAllowWhiteSpaceInCharacters. |
AnchorAllowWhiteSpaceInCharactersMetadata | Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.. |
AnchorCaseSensitive | When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.. |
AnchorCaseSensitiveMetadata | Metadata that indicates whether the `anchorCaseSensitive` property is editable.. |
AnchorHorizontalAlignment | Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.. |
AnchorHorizontalAlignmentMetadata | Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.. |
AnchorIgnoreIfNotPresent | When set to true, this tab is ignored if anchorString is not found in the document.. |
AnchorIgnoreIfNotPresentMetadata | Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.. |
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.. |
AnchorMatchWholeWordMetadata | Metadata that indicates whether the `anchorMatchWholeWord` property is editable.. |
AnchorString | Anchor text information for a radio button.. |
AnchorStringMetadata | Metadata that indicates whether the `anchorString` property is editable.. |
AnchorTabProcessorVersion | AnchorTabProcessorVersion. |
AnchorTabProcessorVersionMetadata | Reserved for DocuSign.. |
AnchorUnits | Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.. |
AnchorUnitsMetadata | Metadata that indicates whether the `anchorUnits` property is editable.. |
AnchorXOffset | Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.. |
AnchorXOffsetMetadata | Metadata that indicates whether the `anchorXOffset` property is editable.. |
AnchorYOffset | Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.. |
AnchorYOffsetMetadata | Metadata that indicates whether the `anchorYOffset` property is editable.. |
Bold | When set to true, the information in the tab is bold.. |
BoldMetadata | Metadata that indicates whether the `bold` property is editable.. |
Caption | Caption. |
CaptionMetadata | CaptionMetadata. |
ConditionalParentLabel | For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.. |
ConditionalParentLabelMetadata | Metadata that indicates whether the `conditionalParentLabel` property is editable.. |
ConditionalParentValue | 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. . |
ConditionalParentValueMetadata | Metadata that indicates whether the `conditionalParentValue` property is editable.. |
CustomTabId | 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.. |
CustomTabIdMetadata | Metadata that indicates whether the `customTabId` property is editable.. |
DocumentId | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.. |
DocumentIdMetadata | Metadata that indicates whether the `documentId` property is editable.. |
ErrorDetails | Array or errors.. |
Font | 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.. |
FontColor | The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.. |
FontColorMetadata | Metadata that indicates whether the `fontColor` property is editable.. |
FontMetadata | Metadata that indicates whether the `font` property is editable.. |
FontSize | 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.. |
FontSizeMetadata | Metadata that indicates whether the `fontSize` property is editable.. |
FormOrder | FormOrder. |
FormOrderMetadata | Metadata that indicates whether the `formOrder` property is editable.. |
FormPageLabel | FormPageLabel. |
FormPageLabelMetadata | Metadata that indicates whether the `formPageLabel` property is editable.. |
FormPageNumber | FormPageNumber. |
FormPageNumberMetadata | Metadata that indicates whether the `fromPageNumber` property is editable.. |
Height | Height of the tab in pixels.. |
HeightMetadata | Metadata that indicates whether the `height` property is editable.. |
Italic | When set to true, the information in the tab is italic.. |
ItalicMetadata | Metadata that indicates whether the `italic` property is editable.. |
Locked | When set to true, the signer cannot change the data of the custom tab.. |
LockedMetadata | Metadata that indicates whether the `locked` property is editable.. |
MergeField | Contains the information necessary to map the tab to a field in SalesForce.. |
MergeFieldXml | MergeFieldXml. |
Name | Specifies the tool tip text for the tab.. |
NameMetadata | Metadata that indicates whether the `name` property is editable. This property is read-only.. |
PageNumber | Specifies the page number on which the tab is located.. |
PageNumberMetadata | Metadata that indicates whether the `pageNumber` property is editable.. |
RecipientId | Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.. |
RecipientIdGuid | RecipientIdGuid. |
RecipientIdGuidMetadata | Metadata that indicates whether the `recipientIdGuid` property is editable.. |
RecipientIdMetadata | Metadata that indicates whether the `recipientId` property is editable.. |
Required | When set to true, the signer is required to fill out this tab. |
RequiredMetadata | Metadata that indicates whether the `required` property is editable.. |
RequireInitialOnSharedChange | Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.. |
RequireInitialOnSharedChangeMetadata | Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.. |
Selected | When set to true, the checkbox is selected.. |
SelectedMetadata | Metadata that indicates whether the `selected` property is editable.. |
SelectedOriginal | SelectedOriginal. |
SelectedOriginalMetadata | SelectedOriginalMetadata. |
Shared | When set to true, this custom tab is shared.. |
SharedMetadata | Metadata that indicates whether the `shared` property is editable. . |
ShareToRecipients | ShareToRecipients. |
ShareToRecipientsMetadata | Reserved for DocuSign.. |
SmartContractInformation | Reserved for DocuSign.. |
Source | Source. |
Status | 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.. |
StatusMetadata | Metadata that indicates whether the `status` property is editable.. |
TabGroupLabels | TabGroupLabels. |
TabGroupLabelsMetadata | Metadata that indicates whether the `tabGroupLabels` property is editable.. |
TabId | The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. . |
TabIdMetadata | Metadata that indicates whether the `tabId` property is editable.. |
TabLabel | The label string associated with the tab.. |
TabLabelMetadata | Metadata that indicates whether the `tabLabel` property is editable.. |
TabOrder | TabOrder. |
TabOrderMetadata | Metadata that indicates whether the `tabOrder` property is editable.. |
TabType | TabType. |
TabTypeMetadata | Metadata that indicates whether the `tabType` property is editable.. |
TemplateLocked | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. . |
TemplateLockedMetadata | Metadata that indicates whether the `templateLocked` property is editable.. |
TemplateRequired | When set to true, the sender may not remove the recipient. Used only when working with template recipients.. |
TemplateRequiredMetadata | Metadata that indicates whether the `templateRequired` property is editable.. |
Tooltip | Tooltip. |
ToolTipMetadata | Metadata that indicates whether the `toolTip` property is editable.. |
Underline | When set to true, the information in the tab is underlined.. |
UnderlineMetadata | Metadata that indicates whether the `underline` property is editable.. |
Width | Width of the tab in pixels.. |
WidthMetadata | Metadata that indicates whether the `width` property is editable.. |
XPosition | This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position.. |
XPositionMetadata | Metadata that indicates whether the `xPosition` property is editable.. |
YPosition | This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position.. |
YPositionMetadata | Metadata that indicates whether the `yPosition` property is editable.. |
|
inline |
Returns true if objects are equal
obj | Object to be compared |
|
inline |
|
inline |
Gets the hash code
|
inline |
Returns the JSON string presentation of the object
|
inline |
Returns the string presentation of the object
|
getset |
Gets or Sets AnchorAllowWhiteSpaceInCharacters
|
getset |
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
Metadata that indicates whether the `anchorAllowWhiteSpaceInCharacters` property is editable.
|
getset |
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.
|
getset |
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
Metadata that indicates whether the `anchorCaseSensitive` property is editable.
|
getset |
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.
|
getset |
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
Metadata that indicates whether the `anchorHorizontalAlignment` property is editable.
|
getset |
When set to true, this tab is ignored if anchorString is not found in the document.
When set to true, this tab is ignored if anchorString is not found in the document.
|
getset |
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
Metadata that indicates whether the `anchorIgnoreIfNotPresent` property is editable.
|
getset |
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.
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.
|
getset |
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
Metadata that indicates whether the `anchorMatchWholeWord` property is editable.
|
getset |
Anchor text information for a radio button.
Anchor text information for a radio button.
|
getset |
Metadata that indicates whether the `anchorString` property is editable.
Metadata that indicates whether the `anchorString` property is editable.
|
getset |
Gets or Sets AnchorTabProcessorVersion
|
getset |
|
getset |
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.
|
getset |
Metadata that indicates whether the `anchorUnits` property is editable.
Metadata that indicates whether the `anchorUnits` property is editable.
|
getset |
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.
|
getset |
Metadata that indicates whether the `anchorXOffset` property is editable.
Metadata that indicates whether the `anchorXOffset` property is editable.
|
getset |
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.
|
getset |
Metadata that indicates whether the `anchorYOffset` property is editable.
Metadata that indicates whether the `anchorYOffset` property is editable.
|
getset |
When set to true, the information in the tab is bold.
When set to true, the information in the tab is bold.
|
getset |
Metadata that indicates whether the `bold` property is editable.
Metadata that indicates whether the `bold` property is editable.
|
getset |
Gets or Sets Caption
|
getset |
Gets or Sets CaptionMetadata
|
getset |
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
|
getset |
Metadata that indicates whether the `conditionalParentLabel` property is editable.
Metadata that indicates whether the `conditionalParentLabel` property is editable.
|
getset |
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.
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.
|
getset |
Metadata that indicates whether the `conditionalParentValue` property is editable.
Metadata that indicates whether the `conditionalParentValue` property is editable.
|
getset |
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.
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.
|
getset |
Metadata that indicates whether the `customTabId` property is editable.
Metadata that indicates whether the `customTabId` property is editable.
|
getset |
|
getset |
Metadata that indicates whether the `documentId` property is editable.
Metadata that indicates whether the `documentId` property is editable.
|
getset |
Array or errors.
Array or errors.
|
getset |
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.
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.
|
getset |
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White.
|
getset |
Metadata that indicates whether the `fontColor` property is editable.
Metadata that indicates whether the `fontColor` property is editable.
|
getset |
Metadata that indicates whether the `font` property is editable.
Metadata that indicates whether the `font` property is editable.
|
getset |
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.
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.
|
getset |
Metadata that indicates whether the `fontSize` property is editable.
Metadata that indicates whether the `fontSize` property is editable.
|
getset |
Gets or Sets FormOrder
|
getset |
Metadata that indicates whether the `formOrder` property is editable.
Metadata that indicates whether the `formOrder` property is editable.
|
getset |
Gets or Sets FormPageLabel
|
getset |
Metadata that indicates whether the `formPageLabel` property is editable.
Metadata that indicates whether the `formPageLabel` property is editable.
|
getset |
Gets or Sets FormPageNumber
|
getset |
Metadata that indicates whether the `fromPageNumber` property is editable.
Metadata that indicates whether the `fromPageNumber` property is editable.
|
getset |
Height of the tab in pixels.
Height of the tab in pixels.
|
getset |
Metadata that indicates whether the `height` property is editable.
Metadata that indicates whether the `height` property is editable.
|
getset |
When set to true, the information in the tab is italic.
When set to true, the information in the tab is italic.
|
getset |
Metadata that indicates whether the `italic` property is editable.
Metadata that indicates whether the `italic` property is editable.
|
getset |
When set to true, the signer cannot change the data of the custom tab.
When set to true, the signer cannot change the data of the custom tab.
|
getset |
Metadata that indicates whether the `locked` property is editable.
Metadata that indicates whether the `locked` property is editable.
|
getset |
Contains the information necessary to map the tab to a field in SalesForce.
Contains the information necessary to map the tab to a field in SalesForce.
|
getset |
Gets or Sets MergeFieldXml
|
getset |
Specifies the tool tip text for the tab.
Specifies the tool tip text for the tab.
|
getset |
Metadata that indicates whether the `name` property is editable. This property is read-only.
Metadata that indicates whether the `name` property is editable. This property is read-only.
|
getset |
Specifies the page number on which the tab is located.
Specifies the page number on which the tab is located.
|
getset |
Metadata that indicates whether the `pageNumber` property is editable.
Metadata that indicates whether the `pageNumber` property is editable.
|
getset |
|
getset |
Gets or Sets RecipientIdGuid
|
getset |
Metadata that indicates whether the `recipientIdGuid` property is editable.
Metadata that indicates whether the `recipientIdGuid` property is editable.
|
getset |
Metadata that indicates whether the `recipientId` property is editable.
Metadata that indicates whether the `recipientId` property is editable.
|
getset |
When set to true, the signer is required to fill out this tab
When set to true, the signer is required to fill out this tab
|
getset |
Metadata that indicates whether the `required` property is editable.
Metadata that indicates whether the `required` property is editable.
|
getset |
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
|
getset |
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
Metadata that indicates whether the `requireInitialOnSharedChange` property is editable.
|
getset |
When set to true, the checkbox is selected.
When set to true, the checkbox is selected.
|
getset |
Metadata that indicates whether the `selected` property is editable.
Metadata that indicates whether the `selected` property is editable.
|
getset |
Gets or Sets SelectedOriginal
|
getset |
Gets or Sets SelectedOriginalMetadata
|
getset |
When set to true, this custom tab is shared.
When set to true, this custom tab is shared.
|
getset |
Metadata that indicates whether the `shared` property is editable.
Metadata that indicates whether the `shared` property is editable.
|
getset |
Gets or Sets ShareToRecipients
|
getset |
|
getset |
|
getset |
Gets or Sets Source
|
getset |
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.
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.
|
getset |
Metadata that indicates whether the `status` property is editable.
Metadata that indicates whether the `status` property is editable.
|
getset |
Gets or Sets TabGroupLabels
|
getset |
Metadata that indicates whether the `tabGroupLabels` property is editable.
Metadata that indicates whether the `tabGroupLabels` property is editable.
|
getset |
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].
|
getset |
Metadata that indicates whether the `tabId` property is editable.
Metadata that indicates whether the `tabId` property is editable.
|
getset |
The label string associated with the tab.
The label string associated with the tab.
|
getset |
Metadata that indicates whether the `tabLabel` property is editable.
Metadata that indicates whether the `tabLabel` property is editable.
|
getset |
Gets or Sets TabOrder
|
getset |
Metadata that indicates whether the `tabOrder` property is editable.
Metadata that indicates whether the `tabOrder` property is editable.
|
getset |
Gets or Sets TabType
|
getset |
Metadata that indicates whether the `tabType` property is editable.
Metadata that indicates whether the `tabType` property is editable.
|
getset |
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
|
getset |
Metadata that indicates whether the `templateLocked` property is editable.
Metadata that indicates whether the `templateLocked` property is editable.
|
getset |
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
|
getset |
Metadata that indicates whether the `templateRequired` property is editable.
Metadata that indicates whether the `templateRequired` property is editable.
|
getset |
Gets or Sets Tooltip
|
getset |
Metadata that indicates whether the `toolTip` property is editable.
Metadata that indicates whether the `toolTip` property is editable.
|
getset |
When set to true, the information in the tab is underlined.
When set to true, the information in the tab is underlined.
|
getset |
Metadata that indicates whether the `underline` property is editable.
Metadata that indicates whether the `underline` property is editable.
|
getset |
Width of the tab in pixels.
Width of the tab in pixels.
|
getset |
Metadata that indicates whether the `width` property is editable.
Metadata that indicates whether the `width` property is editable.
|
getset |
|
getset |
Metadata that indicates whether the `xPosition` property is editable.
Metadata that indicates whether the `xPosition` property is editable.
|
getset |
|
getset |
Metadata that indicates whether the `yPosition` property is editable.
Metadata that indicates whether the `yPosition` property is editable.