Docusign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.Checkbox Class Reference

A tab that allows the recipient to select a yes/no (on/off) option. More...

Inheritance diagram for DocuSign.eSign.Model.Checkbox:

Public Member Functions

 Checkbox (string AnchorAllowWhiteSpaceInCharacters=default(string), PropertyMetadata AnchorAllowWhiteSpaceInCharactersMetadata=default(PropertyMetadata), string AnchorCaseSensitive=default(string), PropertyMetadata AnchorCaseSensitiveMetadata=default(PropertyMetadata), string AnchorHorizontalAlignment=default(string), PropertyMetadata AnchorHorizontalAlignmentMetadata=default(PropertyMetadata), string AnchorIgnoreIfNotPresent=default(string), PropertyMetadata AnchorIgnoreIfNotPresentMetadata=default(PropertyMetadata), string AnchorMatchWholeWord=default(string), PropertyMetadata AnchorMatchWholeWordMetadata=default(PropertyMetadata), string AnchorString=default(string), PropertyMetadata AnchorStringMetadata=default(PropertyMetadata), string AnchorTabProcessorVersion=default(string), PropertyMetadata AnchorTabProcessorVersionMetadata=default(PropertyMetadata), string AnchorUnits=default(string), PropertyMetadata AnchorUnitsMetadata=default(PropertyMetadata), string AnchorXOffset=default(string), PropertyMetadata AnchorXOffsetMetadata=default(PropertyMetadata), string AnchorYOffset=default(string), PropertyMetadata AnchorYOffsetMetadata=default(PropertyMetadata), string Bold=default(string), PropertyMetadata BoldMetadata=default(PropertyMetadata), string Caption=default(string), PropertyMetadata CaptionMetadata=default(PropertyMetadata), string ConditionalParentLabel=default(string), PropertyMetadata ConditionalParentLabelMetadata=default(PropertyMetadata), string ConditionalParentValue=default(string), PropertyMetadata ConditionalParentValueMetadata=default(PropertyMetadata), string CustomTabId=default(string), PropertyMetadata CustomTabIdMetadata=default(PropertyMetadata), string DocumentId=default(string), PropertyMetadata DocumentIdMetadata=default(PropertyMetadata), ErrorDetails ErrorDetails=default(ErrorDetails), string Font=default(string), string FontColor=default(string), PropertyMetadata FontColorMetadata=default(PropertyMetadata), PropertyMetadata FontMetadata=default(PropertyMetadata), string FontSize=default(string), PropertyMetadata FontSizeMetadata=default(PropertyMetadata), string FormOrder=default(string), PropertyMetadata FormOrderMetadata=default(PropertyMetadata), string FormPageLabel=default(string), PropertyMetadata FormPageLabelMetadata=default(PropertyMetadata), string FormPageNumber=default(string), PropertyMetadata FormPageNumberMetadata=default(PropertyMetadata), string Height=default(string), PropertyMetadata HeightMetadata=default(PropertyMetadata), string Italic=default(string), PropertyMetadata ItalicMetadata=default(PropertyMetadata), string Locked=default(string), PropertyMetadata LockedMetadata=default(PropertyMetadata), MergeField MergeField=default(MergeField), string MergeFieldXml=default(string), string Name=default(string), PropertyMetadata NameMetadata=default(PropertyMetadata), string PageNumber=default(string), PropertyMetadata PageNumberMetadata=default(PropertyMetadata), string RecipientId=default(string), string RecipientIdGuid=default(string), PropertyMetadata RecipientIdGuidMetadata=default(PropertyMetadata), PropertyMetadata RecipientIdMetadata=default(PropertyMetadata), string Required=default(string), PropertyMetadata RequiredMetadata=default(PropertyMetadata), string RequireInitialOnSharedChange=default(string), PropertyMetadata RequireInitialOnSharedChangeMetadata=default(PropertyMetadata), string Selected=default(string), PropertyMetadata SelectedMetadata=default(PropertyMetadata), string SelectedOriginal=default(string), PropertyMetadata SelectedOriginalMetadata=default(PropertyMetadata), string Shared=default(string), PropertyMetadata SharedMetadata=default(PropertyMetadata), string ShareToRecipients=default(string), PropertyMetadata ShareToRecipientsMetadata=default(PropertyMetadata), SmartContractInformation SmartContractInformation=default(SmartContractInformation), string Source=default(string), string Status=default(string), PropertyMetadata StatusMetadata=default(PropertyMetadata), List< string > TabGroupLabels=default(List< string >), PropertyMetadata TabGroupLabelsMetadata=default(PropertyMetadata), string TabId=default(string), PropertyMetadata TabIdMetadata=default(PropertyMetadata), string TabLabel=default(string), PropertyMetadata TabLabelMetadata=default(PropertyMetadata), string TabOrder=default(string), PropertyMetadata TabOrderMetadata=default(PropertyMetadata), string TabType=default(string), PropertyMetadata TabTypeMetadata=default(PropertyMetadata), string TemplateLocked=default(string), PropertyMetadata TemplateLockedMetadata=default(PropertyMetadata), string TemplateRequired=default(string), PropertyMetadata TemplateRequiredMetadata=default(PropertyMetadata), string Tooltip=default(string), PropertyMetadata ToolTipMetadata=default(PropertyMetadata), string Underline=default(string), PropertyMetadata UnderlineMetadata=default(PropertyMetadata), string Width=default(string), PropertyMetadata WidthMetadata=default(PropertyMetadata), string XPosition=default(string), PropertyMetadata XPositionMetadata=default(PropertyMetadata), string YPosition=default(string), PropertyMetadata YPositionMetadata=default(PropertyMetadata))
 Initializes a new instance of the Checkbox class. More...
 
override string ToString ()
 Returns the string presentation of the object More...
 
string ToJson ()
 Returns the JSON string presentation of the object More...
 
override bool Equals (object obj)
 Returns true if objects are equal More...
 
bool Equals (Checkbox other)
 Returns true if Checkbox instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string AnchorAllowWhiteSpaceInCharacters [get, set]
 Gets or Sets AnchorAllowWhiteSpaceInCharacters More...
 
PropertyMetadata AnchorAllowWhiteSpaceInCharactersMetadata [get, set]
 Metadata that indicates whether the &#x60;anchorAllowWhiteSpaceInCharacters&#x60; 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 &#x60;anchorCaseSensitive&#x60; 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 &#x60;anchorHorizontalAlignment&#x60; 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 &#x60;anchorIgnoreIfNotPresent&#x60; 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 &#x60;anchorMatchWholeWord&#x60; 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 &#x60;anchorString&#x60; 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 &#x60;anchorUnits&#x60; 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 &#x60;anchorXOffset&#x60; 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 &#x60;anchorYOffset&#x60; 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 &#x60;bold&#x60; 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&#39;s visibility. More...
 
PropertyMetadata ConditionalParentLabelMetadata [get, set]
 Metadata that indicates whether the &#x60;conditionalParentLabel&#x60; property is editable. More...
 
string ConditionalParentValue [get, set]
 For conditional fields, this is the value of the parent tab that controls the tab&#39;s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use &quot;on&quot; as the value to show that the parent tab is active. More...
 
PropertyMetadata ConditionalParentValueMetadata [get, set]
 Metadata that indicates whether the &#x60;conditionalParentValue&#x60; 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 &#x60;customTabId&#x60; 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&#39;s ID attribute. More...
 
PropertyMetadata DocumentIdMetadata [get, set]
 Metadata that indicates whether the &#x60;documentId&#x60; 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 &#x60;fontColor&#x60; property is editable. More...
 
PropertyMetadata FontMetadata [get, set]
 Metadata that indicates whether the &#x60;font&#x60; 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 &#x60;fontSize&#x60; property is editable. More...
 
string FormOrder [get, set]
 Gets or Sets FormOrder More...
 
PropertyMetadata FormOrderMetadata [get, set]
 Metadata that indicates whether the &#x60;formOrder&#x60; property is editable. More...
 
string FormPageLabel [get, set]
 Gets or Sets FormPageLabel More...
 
PropertyMetadata FormPageLabelMetadata [get, set]
 Metadata that indicates whether the &#x60;formPageLabel&#x60; property is editable. More...
 
string FormPageNumber [get, set]
 Gets or Sets FormPageNumber More...
 
PropertyMetadata FormPageNumberMetadata [get, set]
 Metadata that indicates whether the &#x60;fromPageNumber&#x60; property is editable. More...
 
string Height [get, set]
 Height of the tab in pixels. More...
 
PropertyMetadata HeightMetadata [get, set]
 Metadata that indicates whether the &#x60;height&#x60; 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 &#x60;italic&#x60; 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 &#x60;locked&#x60; 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 &#x60;name&#x60; 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 &#x60;pageNumber&#x60; 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 &#x60;recipientIdGuid&#x60; property is editable. More...
 
PropertyMetadata RecipientIdMetadata [get, set]
 Metadata that indicates whether the &#x60;recipientId&#x60; 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 &#x60;required&#x60; 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 &#x60;requireInitialOnSharedChange&#x60; 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 &#x60;selected&#x60; 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 &#x60;shared&#x60; 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 &#x60;status&#x60; property is editable. More...
 
List< string > TabGroupLabels [get, set]
 Gets or Sets TabGroupLabels More...
 
PropertyMetadata TabGroupLabelsMetadata [get, set]
 Metadata that indicates whether the &#x60;tabGroupLabels&#x60; 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 &#x60;tabId&#x60; 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 &#x60;tabLabel&#x60; property is editable. More...
 
string TabOrder [get, set]
 Gets or Sets TabOrder More...
 
PropertyMetadata TabOrderMetadata [get, set]
 Metadata that indicates whether the &#x60;tabOrder&#x60; property is editable. More...
 
string TabType [get, set]
 Gets or Sets TabType More...
 
PropertyMetadata TabTypeMetadata [get, set]
 Metadata that indicates whether the &#x60;tabType&#x60; 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 &#x60;templateLocked&#x60; 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 &#x60;templateRequired&#x60; property is editable. More...
 
string Tooltip [get, set]
 Gets or Sets Tooltip More...
 
PropertyMetadata ToolTipMetadata [get, set]
 Metadata that indicates whether the &#x60;toolTip&#x60; 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 &#x60;underline&#x60; property is editable. More...
 
string Width [get, set]
 Width of the tab in pixels. More...
 
PropertyMetadata WidthMetadata [get, set]
 Metadata that indicates whether the &#x60;width&#x60; 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 &#x60;xPosition&#x60; 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 &#x60;yPosition&#x60; property is editable. More...
 

Detailed Description

A tab that allows the recipient to select a yes/no (on/off) option.

Constructor & Destructor Documentation

◆ Checkbox()

DocuSign.eSign.Model.Checkbox.Checkbox ( string  AnchorAllowWhiteSpaceInCharacters = default(string),
PropertyMetadata  AnchorAllowWhiteSpaceInCharactersMetadata = default(PropertyMetadata),
string  AnchorCaseSensitive = default(string),
PropertyMetadata  AnchorCaseSensitiveMetadata = default(PropertyMetadata),
string  AnchorHorizontalAlignment = default(string),
PropertyMetadata  AnchorHorizontalAlignmentMetadata = default(PropertyMetadata),
string  AnchorIgnoreIfNotPresent = default(string),
PropertyMetadata  AnchorIgnoreIfNotPresentMetadata = default(PropertyMetadata),
string  AnchorMatchWholeWord = default(string),
PropertyMetadata  AnchorMatchWholeWordMetadata = default(PropertyMetadata),
string  AnchorString = default(string),
PropertyMetadata  AnchorStringMetadata = default(PropertyMetadata),
string  AnchorTabProcessorVersion = default(string),
PropertyMetadata  AnchorTabProcessorVersionMetadata = default(PropertyMetadata),
string  AnchorUnits = default(string),
PropertyMetadata  AnchorUnitsMetadata = default(PropertyMetadata),
string  AnchorXOffset = default(string),
PropertyMetadata  AnchorXOffsetMetadata = default(PropertyMetadata),
string  AnchorYOffset = default(string),
PropertyMetadata  AnchorYOffsetMetadata = default(PropertyMetadata),
string  Bold = default(string),
PropertyMetadata  BoldMetadata = default(PropertyMetadata),
string  Caption = default(string),
PropertyMetadata  CaptionMetadata = default(PropertyMetadata),
string  ConditionalParentLabel = default(string),
PropertyMetadata  ConditionalParentLabelMetadata = default(PropertyMetadata),
string  ConditionalParentValue = default(string),
PropertyMetadata  ConditionalParentValueMetadata = default(PropertyMetadata),
string  CustomTabId = default(string),
PropertyMetadata  CustomTabIdMetadata = default(PropertyMetadata),
string  DocumentId = default(string),
PropertyMetadata  DocumentIdMetadata = default(PropertyMetadata),
ErrorDetails  ErrorDetails = default(ErrorDetails),
string  Font = default(string),
string  FontColor = default(string),
PropertyMetadata  FontColorMetadata = default(PropertyMetadata),
PropertyMetadata  FontMetadata = default(PropertyMetadata),
string  FontSize = default(string),
PropertyMetadata  FontSizeMetadata = default(PropertyMetadata),
string  FormOrder = default(string),
PropertyMetadata  FormOrderMetadata = default(PropertyMetadata),
string  FormPageLabel = default(string),
PropertyMetadata  FormPageLabelMetadata = default(PropertyMetadata),
string  FormPageNumber = default(string),
PropertyMetadata  FormPageNumberMetadata = default(PropertyMetadata),
string  Height = default(string),
PropertyMetadata  HeightMetadata = default(PropertyMetadata),
string  Italic = default(string),
PropertyMetadata  ItalicMetadata = default(PropertyMetadata),
string  Locked = default(string),
PropertyMetadata  LockedMetadata = default(PropertyMetadata),
MergeField  MergeField = default(MergeField),
string  MergeFieldXml = default(string),
string  Name = default(string),
PropertyMetadata  NameMetadata = default(PropertyMetadata),
string  PageNumber = default(string),
PropertyMetadata  PageNumberMetadata = default(PropertyMetadata),
string  RecipientId = default(string),
string  RecipientIdGuid = default(string),
PropertyMetadata  RecipientIdGuidMetadata = default(PropertyMetadata),
PropertyMetadata  RecipientIdMetadata = default(PropertyMetadata),
string  Required = default(string),
PropertyMetadata  RequiredMetadata = default(PropertyMetadata),
string  RequireInitialOnSharedChange = default(string),
PropertyMetadata  RequireInitialOnSharedChangeMetadata = default(PropertyMetadata),
string  Selected = default(string),
PropertyMetadata  SelectedMetadata = default(PropertyMetadata),
string  SelectedOriginal = default(string),
PropertyMetadata  SelectedOriginalMetadata = default(PropertyMetadata),
string  Shared = default(string),
PropertyMetadata  SharedMetadata = default(PropertyMetadata),
string  ShareToRecipients = default(string),
PropertyMetadata  ShareToRecipientsMetadata = default(PropertyMetadata),
SmartContractInformation  SmartContractInformation = default(SmartContractInformation),
string  Source = default(string),
string  Status = default(string),
PropertyMetadata  StatusMetadata = default(PropertyMetadata),
List< string >  TabGroupLabels = default(List<string>),
PropertyMetadata  TabGroupLabelsMetadata = default(PropertyMetadata),
string  TabId = default(string),
PropertyMetadata  TabIdMetadata = default(PropertyMetadata),
string  TabLabel = default(string),
PropertyMetadata  TabLabelMetadata = default(PropertyMetadata),
string  TabOrder = default(string),
PropertyMetadata  TabOrderMetadata = default(PropertyMetadata),
string  TabType = default(string),
PropertyMetadata  TabTypeMetadata = default(PropertyMetadata),
string  TemplateLocked = default(string),
PropertyMetadata  TemplateLockedMetadata = default(PropertyMetadata),
string  TemplateRequired = default(string),
PropertyMetadata  TemplateRequiredMetadata = default(PropertyMetadata),
string  Tooltip = default(string),
PropertyMetadata  ToolTipMetadata = default(PropertyMetadata),
string  Underline = default(string),
PropertyMetadata  UnderlineMetadata = default(PropertyMetadata),
string  Width = default(string),
PropertyMetadata  WidthMetadata = default(PropertyMetadata),
string  XPosition = default(string),
PropertyMetadata  XPositionMetadata = default(PropertyMetadata),
string  YPosition = default(string),
PropertyMetadata  YPositionMetadata = default(PropertyMetadata) 
)
inline

Initializes a new instance of the Checkbox class.

Parameters
AnchorAllowWhiteSpaceInCharactersAnchorAllowWhiteSpaceInCharacters.
AnchorAllowWhiteSpaceInCharactersMetadataMetadata that indicates whether the &#x60;anchorAllowWhiteSpaceInCharacters&#x60; property is editable..
AnchorCaseSensitiveWhen set to true, the anchor string does not consider case when matching strings in the document. The default value is true..
AnchorCaseSensitiveMetadataMetadata that indicates whether the &#x60;anchorCaseSensitive&#x60; property is editable..
AnchorHorizontalAlignmentSpecifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left..
AnchorHorizontalAlignmentMetadataMetadata that indicates whether the &#x60;anchorHorizontalAlignment&#x60; property is editable..
AnchorIgnoreIfNotPresentWhen set to true, this tab is ignored if anchorString is not found in the document..
AnchorIgnoreIfNotPresentMetadataMetadata that indicates whether the &#x60;anchorIgnoreIfNotPresent&#x60; property is editable..
AnchorMatchWholeWordWhen 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..
AnchorMatchWholeWordMetadataMetadata that indicates whether the &#x60;anchorMatchWholeWord&#x60; property is editable..
AnchorStringAnchor text information for a radio button..
AnchorStringMetadataMetadata that indicates whether the &#x60;anchorString&#x60; property is editable..
AnchorTabProcessorVersionAnchorTabProcessorVersion.
AnchorTabProcessorVersionMetadataReserved for DocuSign..
AnchorUnitsSpecifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
AnchorUnitsMetadataMetadata that indicates whether the &#x60;anchorUnits&#x60; property is editable..
AnchorXOffsetSpecifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
AnchorXOffsetMetadataMetadata that indicates whether the &#x60;anchorXOffset&#x60; property is editable..
AnchorYOffsetSpecifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
AnchorYOffsetMetadataMetadata that indicates whether the &#x60;anchorYOffset&#x60; property is editable..
BoldWhen set to true, the information in the tab is bold..
BoldMetadataMetadata that indicates whether the &#x60;bold&#x60; property is editable..
CaptionCaption.
CaptionMetadataCaptionMetadata.
ConditionalParentLabelFor conditional fields this is the TabLabel of the parent tab that controls this tab&#39;s visibility..
ConditionalParentLabelMetadataMetadata that indicates whether the &#x60;conditionalParentLabel&#x60; property is editable..
ConditionalParentValueFor conditional fields, this is the value of the parent tab that controls the tab&#39;s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use &quot;on&quot; as the value to show that the parent tab is active. .
ConditionalParentValueMetadataMetadata that indicates whether the &#x60;conditionalParentValue&#x60; property is editable..
CustomTabIdThe 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..
CustomTabIdMetadataMetadata that indicates whether the &#x60;customTabId&#x60; property is editable..
DocumentIdSpecifies the document ID number that the tab is placed on. This must refer to an existing Document&#39;s ID attribute..
DocumentIdMetadataMetadata that indicates whether the &#x60;documentId&#x60; property is editable..
ErrorDetailsArray or errors..
FontThe 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..
FontColorThe font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
FontColorMetadataMetadata that indicates whether the &#x60;fontColor&#x60; property is editable..
FontMetadataMetadata that indicates whether the &#x60;font&#x60; property is editable..
FontSizeThe 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..
FontSizeMetadataMetadata that indicates whether the &#x60;fontSize&#x60; property is editable..
FormOrderFormOrder.
FormOrderMetadataMetadata that indicates whether the &#x60;formOrder&#x60; property is editable..
FormPageLabelFormPageLabel.
FormPageLabelMetadataMetadata that indicates whether the &#x60;formPageLabel&#x60; property is editable..
FormPageNumberFormPageNumber.
FormPageNumberMetadataMetadata that indicates whether the &#x60;fromPageNumber&#x60; property is editable..
HeightHeight of the tab in pixels..
HeightMetadataMetadata that indicates whether the &#x60;height&#x60; property is editable..
ItalicWhen set to true, the information in the tab is italic..
ItalicMetadataMetadata that indicates whether the &#x60;italic&#x60; property is editable..
LockedWhen set to true, the signer cannot change the data of the custom tab..
LockedMetadataMetadata that indicates whether the &#x60;locked&#x60; property is editable..
MergeFieldContains the information necessary to map the tab to a field in SalesForce..
MergeFieldXmlMergeFieldXml.
NameSpecifies the tool tip text for the tab..
NameMetadataMetadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only..
PageNumberSpecifies the page number on which the tab is located..
PageNumberMetadataMetadata that indicates whether the &#x60;pageNumber&#x60; property is editable..
RecipientIdUnique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
RecipientIdGuidRecipientIdGuid.
RecipientIdGuidMetadataMetadata that indicates whether the &#x60;recipientIdGuid&#x60; property is editable..
RecipientIdMetadataMetadata that indicates whether the &#x60;recipientId&#x60; property is editable..
RequiredWhen set to true, the signer is required to fill out this tab.
RequiredMetadataMetadata that indicates whether the &#x60;required&#x60; property is editable..
RequireInitialOnSharedChangeOptional element for field markup. When set to true, the signer is required to initial when they modify a shared field..
RequireInitialOnSharedChangeMetadataMetadata that indicates whether the &#x60;requireInitialOnSharedChange&#x60; property is editable..
SelectedWhen set to true, the checkbox is selected..
SelectedMetadataMetadata that indicates whether the &#x60;selected&#x60; property is editable..
SelectedOriginalSelectedOriginal.
SelectedOriginalMetadataSelectedOriginalMetadata.
SharedWhen set to true, this custom tab is shared..
SharedMetadataMetadata that indicates whether the &#x60;shared&#x60; property is editable. .
ShareToRecipientsShareToRecipients.
ShareToRecipientsMetadataReserved for DocuSign..
SmartContractInformationReserved for DocuSign..
SourceSource.
StatusIndicates 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..
StatusMetadataMetadata that indicates whether the &#x60;status&#x60; property is editable..
TabGroupLabelsTabGroupLabels.
TabGroupLabelsMetadataMetadata that indicates whether the &#x60;tabGroupLabels&#x60; property is editable..
TabIdThe unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .
TabIdMetadataMetadata that indicates whether the &#x60;tabId&#x60; property is editable..
TabLabelThe label string associated with the tab..
TabLabelMetadataMetadata that indicates whether the &#x60;tabLabel&#x60; property is editable..
TabOrderTabOrder.
TabOrderMetadataMetadata that indicates whether the &#x60;tabOrder&#x60; property is editable..
TabTypeTabType.
TabTypeMetadataMetadata that indicates whether the &#x60;tabType&#x60; property is editable..
TemplateLockedWhen set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateLockedMetadataMetadata that indicates whether the &#x60;templateLocked&#x60; property is editable..
TemplateRequiredWhen set to true, the sender may not remove the recipient. Used only when working with template recipients..
TemplateRequiredMetadataMetadata that indicates whether the &#x60;templateRequired&#x60; property is editable..
TooltipTooltip.
ToolTipMetadataMetadata that indicates whether the &#x60;toolTip&#x60; property is editable..
UnderlineWhen set to true, the information in the tab is underlined..
UnderlineMetadataMetadata that indicates whether the &#x60;underline&#x60; property is editable..
WidthWidth of the tab in pixels..
WidthMetadataMetadata that indicates whether the &#x60;width&#x60; property is editable..
XPositionThis indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position..
XPositionMetadataMetadata that indicates whether the &#x60;xPosition&#x60; property is editable..
YPositionThis indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position..
YPositionMetadataMetadata that indicates whether the &#x60;yPosition&#x60; property is editable..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Checkbox.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Checkbox.Equals ( Checkbox  other)
inline

Returns true if Checkbox instances are equal

Parameters
otherInstance of Checkbox to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Checkbox.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.Checkbox.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Checkbox.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AnchorAllowWhiteSpaceInCharacters

string DocuSign.eSign.Model.Checkbox.AnchorAllowWhiteSpaceInCharacters
getset

Gets or Sets AnchorAllowWhiteSpaceInCharacters

◆ AnchorAllowWhiteSpaceInCharactersMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorAllowWhiteSpaceInCharactersMetadata
getset

Metadata that indicates whether the &#x60;anchorAllowWhiteSpaceInCharacters&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorAllowWhiteSpaceInCharacters&#x60; property is editable.

◆ AnchorCaseSensitive

string DocuSign.eSign.Model.Checkbox.AnchorCaseSensitive
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.

◆ AnchorCaseSensitiveMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorCaseSensitiveMetadata
getset

Metadata that indicates whether the &#x60;anchorCaseSensitive&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorCaseSensitive&#x60; property is editable.

◆ AnchorHorizontalAlignment

string DocuSign.eSign.Model.Checkbox.AnchorHorizontalAlignment
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.

◆ AnchorHorizontalAlignmentMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorHorizontalAlignmentMetadata
getset

Metadata that indicates whether the &#x60;anchorHorizontalAlignment&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorHorizontalAlignment&#x60; property is editable.

◆ AnchorIgnoreIfNotPresent

string DocuSign.eSign.Model.Checkbox.AnchorIgnoreIfNotPresent
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.

◆ AnchorIgnoreIfNotPresentMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorIgnoreIfNotPresentMetadata
getset

Metadata that indicates whether the &#x60;anchorIgnoreIfNotPresent&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorIgnoreIfNotPresent&#x60; property is editable.

◆ AnchorMatchWholeWord

string DocuSign.eSign.Model.Checkbox.AnchorMatchWholeWord
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.

◆ AnchorMatchWholeWordMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorMatchWholeWordMetadata
getset

Metadata that indicates whether the &#x60;anchorMatchWholeWord&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorMatchWholeWord&#x60; property is editable.

◆ AnchorString

string DocuSign.eSign.Model.Checkbox.AnchorString
getset

Anchor text information for a radio button.

Anchor text information for a radio button.

◆ AnchorStringMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorStringMetadata
getset

Metadata that indicates whether the &#x60;anchorString&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorString&#x60; property is editable.

◆ AnchorTabProcessorVersion

string DocuSign.eSign.Model.Checkbox.AnchorTabProcessorVersion
getset

Gets or Sets AnchorTabProcessorVersion

◆ AnchorTabProcessorVersionMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorTabProcessorVersionMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ AnchorUnits

string DocuSign.eSign.Model.Checkbox.AnchorUnits
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.

◆ AnchorUnitsMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorUnitsMetadata
getset

Metadata that indicates whether the &#x60;anchorUnits&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorUnits&#x60; property is editable.

◆ AnchorXOffset

string DocuSign.eSign.Model.Checkbox.AnchorXOffset
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.

◆ AnchorXOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorXOffsetMetadata
getset

Metadata that indicates whether the &#x60;anchorXOffset&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorXOffset&#x60; property is editable.

◆ AnchorYOffset

string DocuSign.eSign.Model.Checkbox.AnchorYOffset
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.

◆ AnchorYOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.AnchorYOffsetMetadata
getset

Metadata that indicates whether the &#x60;anchorYOffset&#x60; property is editable.

Metadata that indicates whether the &#x60;anchorYOffset&#x60; property is editable.

◆ Bold

string DocuSign.eSign.Model.Checkbox.Bold
getset

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

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

◆ BoldMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.BoldMetadata
getset

Metadata that indicates whether the &#x60;bold&#x60; property is editable.

Metadata that indicates whether the &#x60;bold&#x60; property is editable.

◆ Caption

string DocuSign.eSign.Model.Checkbox.Caption
getset

Gets or Sets Caption

◆ CaptionMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.CaptionMetadata
getset

Gets or Sets CaptionMetadata

◆ ConditionalParentLabel

string DocuSign.eSign.Model.Checkbox.ConditionalParentLabel
getset

For conditional fields this is the TabLabel of the parent tab that controls this tab&#39;s visibility.

For conditional fields this is the TabLabel of the parent tab that controls this tab&#39;s visibility.

◆ ConditionalParentLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.ConditionalParentLabelMetadata
getset

Metadata that indicates whether the &#x60;conditionalParentLabel&#x60; property is editable.

Metadata that indicates whether the &#x60;conditionalParentLabel&#x60; property is editable.

◆ ConditionalParentValue

string DocuSign.eSign.Model.Checkbox.ConditionalParentValue
getset

For conditional fields, this is the value of the parent tab that controls the tab&#39;s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use &quot;on&quot; 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&#39;s visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use &quot;on&quot; as the value to show that the parent tab is active.

◆ ConditionalParentValueMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.ConditionalParentValueMetadata
getset

Metadata that indicates whether the &#x60;conditionalParentValue&#x60; property is editable.

Metadata that indicates whether the &#x60;conditionalParentValue&#x60; property is editable.

◆ CustomTabId

string DocuSign.eSign.Model.Checkbox.CustomTabId
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.

◆ CustomTabIdMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.CustomTabIdMetadata
getset

Metadata that indicates whether the &#x60;customTabId&#x60; property is editable.

Metadata that indicates whether the &#x60;customTabId&#x60; property is editable.

◆ DocumentId

string DocuSign.eSign.Model.Checkbox.DocumentId
getset

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

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

◆ DocumentIdMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.DocumentIdMetadata
getset

Metadata that indicates whether the &#x60;documentId&#x60; property is editable.

Metadata that indicates whether the &#x60;documentId&#x60; property is editable.

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Checkbox.ErrorDetails
getset

Array or errors.

Array or errors.

◆ Font

string DocuSign.eSign.Model.Checkbox.Font
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.

◆ FontColor

string DocuSign.eSign.Model.Checkbox.FontColor
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.

◆ FontColorMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FontColorMetadata
getset

Metadata that indicates whether the &#x60;fontColor&#x60; property is editable.

Metadata that indicates whether the &#x60;fontColor&#x60; property is editable.

◆ FontMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FontMetadata
getset

Metadata that indicates whether the &#x60;font&#x60; property is editable.

Metadata that indicates whether the &#x60;font&#x60; property is editable.

◆ FontSize

string DocuSign.eSign.Model.Checkbox.FontSize
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.

◆ FontSizeMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FontSizeMetadata
getset

Metadata that indicates whether the &#x60;fontSize&#x60; property is editable.

Metadata that indicates whether the &#x60;fontSize&#x60; property is editable.

◆ FormOrder

string DocuSign.eSign.Model.Checkbox.FormOrder
getset

Gets or Sets FormOrder

◆ FormOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FormOrderMetadata
getset

Metadata that indicates whether the &#x60;formOrder&#x60; property is editable.

Metadata that indicates whether the &#x60;formOrder&#x60; property is editable.

◆ FormPageLabel

string DocuSign.eSign.Model.Checkbox.FormPageLabel
getset

Gets or Sets FormPageLabel

◆ FormPageLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FormPageLabelMetadata
getset

Metadata that indicates whether the &#x60;formPageLabel&#x60; property is editable.

Metadata that indicates whether the &#x60;formPageLabel&#x60; property is editable.

◆ FormPageNumber

string DocuSign.eSign.Model.Checkbox.FormPageNumber
getset

Gets or Sets FormPageNumber

◆ FormPageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.FormPageNumberMetadata
getset

Metadata that indicates whether the &#x60;fromPageNumber&#x60; property is editable.

Metadata that indicates whether the &#x60;fromPageNumber&#x60; property is editable.

◆ Height

string DocuSign.eSign.Model.Checkbox.Height
getset

Height of the tab in pixels.

Height of the tab in pixels.

◆ HeightMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.HeightMetadata
getset

Metadata that indicates whether the &#x60;height&#x60; property is editable.

Metadata that indicates whether the &#x60;height&#x60; property is editable.

◆ Italic

string DocuSign.eSign.Model.Checkbox.Italic
getset

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

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

◆ ItalicMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.ItalicMetadata
getset

Metadata that indicates whether the &#x60;italic&#x60; property is editable.

Metadata that indicates whether the &#x60;italic&#x60; property is editable.

◆ Locked

string DocuSign.eSign.Model.Checkbox.Locked
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.

◆ LockedMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.LockedMetadata
getset

Metadata that indicates whether the &#x60;locked&#x60; property is editable.

Metadata that indicates whether the &#x60;locked&#x60; property is editable.

◆ MergeField

MergeField DocuSign.eSign.Model.Checkbox.MergeField
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.

◆ MergeFieldXml

string DocuSign.eSign.Model.Checkbox.MergeFieldXml
getset

Gets or Sets MergeFieldXml

◆ Name

string DocuSign.eSign.Model.Checkbox.Name
getset

Specifies the tool tip text for the tab.

Specifies the tool tip text for the tab.

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.NameMetadata
getset

Metadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only.

Metadata that indicates whether the &#x60;name&#x60; property is editable. This property is read-only.

◆ PageNumber

string DocuSign.eSign.Model.Checkbox.PageNumber
getset

Specifies the page number on which the tab is located.

Specifies the page number on which the tab is located.

◆ PageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.PageNumberMetadata
getset

Metadata that indicates whether the &#x60;pageNumber&#x60; property is editable.

Metadata that indicates whether the &#x60;pageNumber&#x60; property is editable.

◆ RecipientId

string DocuSign.eSign.Model.Checkbox.RecipientId
getset

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

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

◆ RecipientIdGuid

string DocuSign.eSign.Model.Checkbox.RecipientIdGuid
getset

Gets or Sets RecipientIdGuid

◆ RecipientIdGuidMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.RecipientIdGuidMetadata
getset

Metadata that indicates whether the &#x60;recipientIdGuid&#x60; property is editable.

Metadata that indicates whether the &#x60;recipientIdGuid&#x60; property is editable.

◆ RecipientIdMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.RecipientIdMetadata
getset

Metadata that indicates whether the &#x60;recipientId&#x60; property is editable.

Metadata that indicates whether the &#x60;recipientId&#x60; property is editable.

◆ Required

string DocuSign.eSign.Model.Checkbox.Required
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

◆ RequiredMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.RequiredMetadata
getset

Metadata that indicates whether the &#x60;required&#x60; property is editable.

Metadata that indicates whether the &#x60;required&#x60; property is editable.

◆ RequireInitialOnSharedChange

string DocuSign.eSign.Model.Checkbox.RequireInitialOnSharedChange
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.

◆ RequireInitialOnSharedChangeMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.RequireInitialOnSharedChangeMetadata
getset

Metadata that indicates whether the &#x60;requireInitialOnSharedChange&#x60; property is editable.

Metadata that indicates whether the &#x60;requireInitialOnSharedChange&#x60; property is editable.

◆ Selected

string DocuSign.eSign.Model.Checkbox.Selected
getset

When set to true, the checkbox is selected.

When set to true, the checkbox is selected.

◆ SelectedMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.SelectedMetadata
getset

Metadata that indicates whether the &#x60;selected&#x60; property is editable.

Metadata that indicates whether the &#x60;selected&#x60; property is editable.

◆ SelectedOriginal

string DocuSign.eSign.Model.Checkbox.SelectedOriginal
getset

Gets or Sets SelectedOriginal

◆ SelectedOriginalMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.SelectedOriginalMetadata
getset

Gets or Sets SelectedOriginalMetadata

◆ Shared

string DocuSign.eSign.Model.Checkbox.Shared
getset

When set to true, this custom tab is shared.

When set to true, this custom tab is shared.

◆ SharedMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.SharedMetadata
getset

Metadata that indicates whether the &#x60;shared&#x60; property is editable.

Metadata that indicates whether the &#x60;shared&#x60; property is editable.

◆ ShareToRecipients

string DocuSign.eSign.Model.Checkbox.ShareToRecipients
getset

Gets or Sets ShareToRecipients

◆ ShareToRecipientsMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.ShareToRecipientsMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ SmartContractInformation

SmartContractInformation DocuSign.eSign.Model.Checkbox.SmartContractInformation
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ Source

string DocuSign.eSign.Model.Checkbox.Source
getset

Gets or Sets Source

◆ Status

string DocuSign.eSign.Model.Checkbox.Status
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.

◆ StatusMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.StatusMetadata
getset

Metadata that indicates whether the &#x60;status&#x60; property is editable.

Metadata that indicates whether the &#x60;status&#x60; property is editable.

◆ TabGroupLabels

List<string> DocuSign.eSign.Model.Checkbox.TabGroupLabels
getset

Gets or Sets TabGroupLabels

◆ TabGroupLabelsMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TabGroupLabelsMetadata
getset

Metadata that indicates whether the &#x60;tabGroupLabels&#x60; property is editable.

Metadata that indicates whether the &#x60;tabGroupLabels&#x60; property is editable.

◆ TabId

string DocuSign.eSign.Model.Checkbox.TabId
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].

◆ TabIdMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TabIdMetadata
getset

Metadata that indicates whether the &#x60;tabId&#x60; property is editable.

Metadata that indicates whether the &#x60;tabId&#x60; property is editable.

◆ TabLabel

string DocuSign.eSign.Model.Checkbox.TabLabel
getset

The label string associated with the tab.

The label string associated with the tab.

◆ TabLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TabLabelMetadata
getset

Metadata that indicates whether the &#x60;tabLabel&#x60; property is editable.

Metadata that indicates whether the &#x60;tabLabel&#x60; property is editable.

◆ TabOrder

string DocuSign.eSign.Model.Checkbox.TabOrder
getset

Gets or Sets TabOrder

◆ TabOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TabOrderMetadata
getset

Metadata that indicates whether the &#x60;tabOrder&#x60; property is editable.

Metadata that indicates whether the &#x60;tabOrder&#x60; property is editable.

◆ TabType

string DocuSign.eSign.Model.Checkbox.TabType
getset

Gets or Sets TabType

◆ TabTypeMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TabTypeMetadata
getset

Metadata that indicates whether the &#x60;tabType&#x60; property is editable.

Metadata that indicates whether the &#x60;tabType&#x60; property is editable.

◆ TemplateLocked

string DocuSign.eSign.Model.Checkbox.TemplateLocked
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.

◆ TemplateLockedMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TemplateLockedMetadata
getset

Metadata that indicates whether the &#x60;templateLocked&#x60; property is editable.

Metadata that indicates whether the &#x60;templateLocked&#x60; property is editable.

◆ TemplateRequired

string DocuSign.eSign.Model.Checkbox.TemplateRequired
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.

◆ TemplateRequiredMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.TemplateRequiredMetadata
getset

Metadata that indicates whether the &#x60;templateRequired&#x60; property is editable.

Metadata that indicates whether the &#x60;templateRequired&#x60; property is editable.

◆ Tooltip

string DocuSign.eSign.Model.Checkbox.Tooltip
getset

Gets or Sets Tooltip

◆ ToolTipMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.ToolTipMetadata
getset

Metadata that indicates whether the &#x60;toolTip&#x60; property is editable.

Metadata that indicates whether the &#x60;toolTip&#x60; property is editable.

◆ Underline

string DocuSign.eSign.Model.Checkbox.Underline
getset

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

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

◆ UnderlineMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.UnderlineMetadata
getset

Metadata that indicates whether the &#x60;underline&#x60; property is editable.

Metadata that indicates whether the &#x60;underline&#x60; property is editable.

◆ Width

string DocuSign.eSign.Model.Checkbox.Width
getset

Width of the tab in pixels.

Width of the tab in pixels.

◆ WidthMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.WidthMetadata
getset

Metadata that indicates whether the &#x60;width&#x60; property is editable.

Metadata that indicates whether the &#x60;width&#x60; property is editable.

◆ XPosition

string DocuSign.eSign.Model.Checkbox.XPosition
getset

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

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

◆ XPositionMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.XPositionMetadata
getset

Metadata that indicates whether the &#x60;xPosition&#x60; property is editable.

Metadata that indicates whether the &#x60;xPosition&#x60; property is editable.

◆ YPosition

string DocuSign.eSign.Model.Checkbox.YPosition
getset

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

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

◆ YPositionMetadata

PropertyMetadata DocuSign.eSign.Model.Checkbox.YPositionMetadata
getset

Metadata that indicates whether the &#x60;yPosition&#x60; property is editable.

Metadata that indicates whether the &#x60;yPosition&#x60; property is editable.


The documentation for this class was generated from the following file: