Inheritance diagram for DocuSign.eSign.Model.TabMetadata:

Public Member Functions
	TabMetadata (string Anchor=default(string), string AnchorCaseSensitive=default(string), string AnchorHorizontalAlignment=default(string), string AnchorIgnoreIfNotPresent=default(string), string AnchorMatchWholeWord=default(string), string AnchorUnits=default(string), string AnchorXOffset=default(string), string AnchorYOffset=default(string), string Bold=default(string), string Collaborative=default(string), string ConcealValueOnDocument=default(string), string CreatedByDisplayName=default(string), string CreatedByUserId=default(string), string CustomTabId=default(string), string DisableAutoSize=default(string), string Editable=default(string), string Font=default(string), string FontColor=default(string), string FontSize=default(string), string Height=default(string), string IncludedInEmail=default(string), string InitialValue=default(string), string Italic=default(string), List< string > Items=default(List< string >), string LastModified=default(string), string LastModifiedByDisplayName=default(string), string LastModifiedByUserId=default(string), LocalePolicyTab LocalePolicy=default(LocalePolicyTab), string Locked=default(string), string MaximumLength=default(string), string MaxNumericalValue=default(string), MergeField MergeField=default(MergeField), string MinNumericalValue=default(string), string Name=default(string), string NumericalValue=default(string), string PaymentItemCode=default(string), string PaymentItemDescription=default(string), string PaymentItemName=default(string), string RequireAll=default(string), string Required=default(string), string RequireInitialOnSharedChange=default(string), string ScaleValue=default(string), string Selected=default(string), string Shared=default(string), string SignatureProviderId=default(string), string StampType=default(string), PropertyMetadata StampTypeMetadata=default(PropertyMetadata), string TabLabel=default(string), string Type=default(string), string Underline=default(string), string ValidationMessage=default(string), string ValidationPattern=default(string), string ValidationType=default(string), string Width=default(string))
	Initializes a new instance of the TabMetadata 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 (TabMetadata other)
	Returns true if TabMetadata instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	Anchor `[get, set]`
	An optional string that is used to auto-match tabs to strings located in the documents of an envelope. 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...

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...

string	AnchorIgnoreIfNotPresent `[get, set]`
	When set to true, this tab is ignored if anchorString is not found in the document. 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...

string	AnchorUnits `[get, set]`
	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. More...

string	AnchorXOffset `[get, set]`
	Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString. More...

string	AnchorYOffset `[get, set]`
	Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString. More...

string	Bold `[get, set]`
	When set to true, the information in the tab is bold. More...

string	Collaborative `[get, set]`
	Gets or Sets Collaborative More...

string	ConcealValueOnDocument `[get, set]`
	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. More...

string	CreatedByDisplayName `[get, set]`
	The user name of the DocuSign user who created this object. More...

string	CreatedByUserId `[get, set]`
	The userId of the DocuSign user who created this object. 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...

string	DisableAutoSize `[get, set]`
	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. More...

string	Editable `[get, set]`
	When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified. 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...

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...

string	Height `[get, set]`
	Height of the tab in pixels. More...

string	IncludedInEmail `[get, set]`
	When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs. More...

string	InitialValue `[get, set]`
	The original value of the tab. More...

string	Italic `[get, set]`
	When set to true, the information in the tab is italic. More...

List< string >	Items `[get, set]`
	If the tab is a list, this represents the values that are possible for the tab. More...

string	LastModified `[get, set]`
	The UTC DateTime this object was last modified. This is in ISO8601 format. More...

string	LastModifiedByDisplayName `[get, set]`
	The User Name of the DocuSign user who last modified this object. More...

string	LastModifiedByUserId `[get, set]`
	The userId of the DocuSign user who last modified this object. More...

LocalePolicyTab	LocalePolicy `[get, set]`
	Reserved for DocuSign. More...

string	Locked `[get, set]`
	When set to true, the signer cannot change the data of the custom tab. More...

string	MaximumLength `[get, set]`
	The maximum number of entry characters supported by the custom tab. More...

string	MaxNumericalValue `[get, set]`
	Gets or Sets MaxNumericalValue More...

MergeField	MergeField `[get, set]`
	Contains the information necessary to map the tab to a field in SalesForce. More...

string	MinNumericalValue `[get, set]`
	Gets or Sets MinNumericalValue More...

string	Name `[get, set]`
	Gets or Sets Name More...

string	NumericalValue `[get, set]`
	Gets or Sets NumericalValue More...

string	PaymentItemCode `[get, set]`
	Gets or Sets PaymentItemCode More...

string	PaymentItemDescription `[get, set]`
	Gets or Sets PaymentItemDescription More...

string	PaymentItemName `[get, set]`
	Gets or Sets PaymentItemName More...

string	RequireAll `[get, set]`
	When set to true and shared is true, information must be entered in this field to complete the envelope. More...

string	Required `[get, set]`
	When set to true, the signer is required to fill out this tab 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...

string	ScaleValue `[get, set]`
	Gets or Sets ScaleValue More...

string	Selected `[get, set]`
	Gets or Sets Selected More...

string	Shared `[get, set]`
	When set to true, this custom tab is shared. More...

string	SignatureProviderId `[get, set]`
	Gets or Sets SignatureProviderId More...

string	StampType `[get, set]`
	Gets or Sets StampType More...

PropertyMetadata	StampTypeMetadata `[get, set]`
	Metadata that indicates whether the `stampType` property is editable. More...

string	TabLabel `[get, set]`
	The label string associated with the tab. More...

string	Type `[get, set]`
	The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4. More...

string	Underline `[get, set]`
	When set to true, the information in the tab is underlined. More...

string	ValidationMessage `[get, set]`
	The message displayed if the custom tab fails input validation (either custom of embedded). More...

string	ValidationPattern `[get, set]`
	A regular expression used to validate input for the tab. More...

string	ValidationType `[get, set]`
	Gets or Sets ValidationType More...

string	Width `[get, set]`
	Width of the tab in pixels. More...

Detailed Description

TabMetadata

Constructor & Destructor Documentation

◆ TabMetadata()

DocuSign.eSign.Model.TabMetadata.TabMetadata	(	string	Anchor = `default(string)`,
		string	AnchorCaseSensitive = `default(string)`,
		string	AnchorHorizontalAlignment = `default(string)`,
		string	AnchorIgnoreIfNotPresent = `default(string)`,
		string	AnchorMatchWholeWord = `default(string)`,
		string	AnchorUnits = `default(string)`,
		string	AnchorXOffset = `default(string)`,
		string	AnchorYOffset = `default(string)`,
		string	Bold = `default(string)`,
		string	Collaborative = `default(string)`,
		string	ConcealValueOnDocument = `default(string)`,
		string	CreatedByDisplayName = `default(string)`,
		string	CreatedByUserId = `default(string)`,
		string	CustomTabId = `default(string)`,
		string	DisableAutoSize = `default(string)`,
		string	Editable = `default(string)`,
		string	Font = `default(string)`,
		string	FontColor = `default(string)`,
		string	FontSize = `default(string)`,
		string	Height = `default(string)`,
		string	IncludedInEmail = `default(string)`,
		string	InitialValue = `default(string)`,
		string	Italic = `default(string)`,
		List< string >	Items = `default(List<string>)`,
		string	LastModified = `default(string)`,
		string	LastModifiedByDisplayName = `default(string)`,
		string	LastModifiedByUserId = `default(string)`,
		LocalePolicyTab	LocalePolicy = `default(LocalePolicyTab)`,
		string	Locked = `default(string)`,
		string	MaximumLength = `default(string)`,
		string	MaxNumericalValue = `default(string)`,
		MergeField	MergeField = `default(MergeField)`,
		string	MinNumericalValue = `default(string)`,
		string	Name = `default(string)`,
		string	NumericalValue = `default(string)`,
		string	PaymentItemCode = `default(string)`,
		string	PaymentItemDescription = `default(string)`,
		string	PaymentItemName = `default(string)`,
		string	RequireAll = `default(string)`,
		string	Required = `default(string)`,
		string	RequireInitialOnSharedChange = `default(string)`,
		string	ScaleValue = `default(string)`,
		string	Selected = `default(string)`,
		string	Shared = `default(string)`,
		string	SignatureProviderId = `default(string)`,
		string	StampType = `default(string)`,
		PropertyMetadata	StampTypeMetadata = `default(PropertyMetadata)`,
		string	TabLabel = `default(string)`,
		string	Type = `default(string)`,
		string	Underline = `default(string)`,
		string	ValidationMessage = `default(string)`,
		string	ValidationPattern = `default(string)`,
		string	ValidationType = `default(string)`,
		string	Width = `default(string)`
	)

inline

Initializes a new instance of the TabMetadata class.

Parameters

Anchor	An optional string that is used to auto-match tabs to strings located in the documents of an envelope..
AnchorCaseSensitive	When set to true, the anchor string does not consider case when matching strings in the document. The default value is true..
AnchorHorizontalAlignment	Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left..
AnchorIgnoreIfNotPresent	When set to true, this tab is ignored if anchorString is not found in the document..
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..
AnchorUnits	Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches..
AnchorXOffset	Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString..
AnchorYOffset	Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString..
Bold	When set to true, the information in the tab is bold..
Collaborative	Collaborative.
ConcealValueOnDocument	When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes..
CreatedByDisplayName	The user name of the DocuSign user who created this object..
CreatedByUserId	The userId of the DocuSign user who created this object..
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..
DisableAutoSize	When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes..
Editable	When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified..
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..
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..
Height	Height of the tab in pixels..
IncludedInEmail	When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs..
InitialValue	The original value of the tab..
Italic	When set to true, the information in the tab is italic..
Items	If the tab is a list, this represents the values that are possible for the tab..
LastModified	The UTC DateTime this object was last modified. This is in ISO8601 format..
LastModifiedByDisplayName	The User Name of the DocuSign user who last modified this object..
LastModifiedByUserId	The userId of the DocuSign user who last modified this object..
LocalePolicy	Reserved for DocuSign..
Locked	When set to true, the signer cannot change the data of the custom tab..
MaximumLength	The maximum number of entry characters supported by the custom tab..
MaxNumericalValue	MaxNumericalValue.
MergeField	Contains the information necessary to map the tab to a field in SalesForce..
MinNumericalValue	MinNumericalValue.
Name	Name.
NumericalValue	NumericalValue.
PaymentItemCode	PaymentItemCode.
PaymentItemDescription	PaymentItemDescription.
PaymentItemName	PaymentItemName.
RequireAll	When set to true and shared is true, information must be entered in this field to complete the envelope. .
Required	When set to true, the signer is required to fill out this tab.
RequireInitialOnSharedChange	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field..
ScaleValue	ScaleValue.
Selected	Selected.
Shared	When set to true, this custom tab is shared..
SignatureProviderId	SignatureProviderId.
StampType	StampType.
StampTypeMetadata	Metadata that indicates whether the `stampType` property is editable..
TabLabel	The label string associated with the tab..
Type	The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4..
Underline	When set to true, the information in the tab is underlined..
ValidationMessage	The message displayed if the custom tab fails input validation (either custom of embedded)..
ValidationPattern	A regular expression used to validate input for the tab..
ValidationType	ValidationType.
Width	Width of the tab in pixels..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.TabMetadata.Equals ( object obj )

inline

Returns true if objects are equal

Parameters

obj	Object to be compared

Returns: Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.TabMetadata.Equals ( TabMetadata other )

inline

Returns true if TabMetadata instances are equal

Parameters

other Instance of TabMetadata to be compared

Returns: Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.TabMetadata.GetHashCode ( )

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

string DocuSign.eSign.Model.TabMetadata.ToJson ( )

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.TabMetadata.ToString ( )

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ Anchor

string DocuSign.eSign.Model.TabMetadata.Anchor

getset

An optional string that is used to auto-match tabs to strings located in the documents of an envelope.

◆ AnchorCaseSensitive

string DocuSign.eSign.Model.TabMetadata.AnchorCaseSensitive

getset

When set to true, the anchor string does not consider case when matching strings in the document. The default value is true.

◆ AnchorHorizontalAlignment

string DocuSign.eSign.Model.TabMetadata.AnchorHorizontalAlignment

getset

Specifies the alignment of anchor tabs with anchor strings. Possible values are left or right. The default value is left.

◆ AnchorIgnoreIfNotPresent

string DocuSign.eSign.Model.TabMetadata.AnchorIgnoreIfNotPresent

getset

When set to true, this tab is ignored if anchorString is not found in the document.

◆ AnchorMatchWholeWord

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

◆ AnchorUnits

string DocuSign.eSign.Model.TabMetadata.AnchorUnits

getset

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches.

◆ AnchorXOffset

string DocuSign.eSign.Model.TabMetadata.AnchorXOffset

getset

Specifies the X axis location of the tab, in anchorUnits, relative to the anchorString.

◆ AnchorYOffset

string DocuSign.eSign.Model.TabMetadata.AnchorYOffset

getset

Specifies the Y axis location of the tab, in anchorUnits, relative to the anchorString.

◆ Bold

string DocuSign.eSign.Model.TabMetadata.Bold

getset

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

◆ Collaborative

string DocuSign.eSign.Model.TabMetadata.Collaborative

getset

Gets or Sets Collaborative

◆ ConcealValueOnDocument

string DocuSign.eSign.Model.TabMetadata.ConcealValueOnDocument

getset

When set to true, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender. When an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console. This setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes.

◆ CreatedByDisplayName

string DocuSign.eSign.Model.TabMetadata.CreatedByDisplayName

getset

The user name of the DocuSign user who created this object.

◆ CreatedByUserId

string DocuSign.eSign.Model.TabMetadata.CreatedByUserId

getset

The userId of the DocuSign user who created this object.

◆ CustomTabId

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

◆ DisableAutoSize

string DocuSign.eSign.Model.TabMetadata.DisableAutoSize

getset

When set to true, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes.

◆ Editable

string DocuSign.eSign.Model.TabMetadata.Editable

getset

When set to true, the custom tab is editable. Otherwise the custom tab cannot be modified.

◆ Font

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

◆ FontColor

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

◆ FontSize

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

◆ Height

string DocuSign.eSign.Model.TabMetadata.Height

getset

Height of the tab in pixels.

◆ IncludedInEmail

string DocuSign.eSign.Model.TabMetadata.IncludedInEmail

getset

When set to true, the tab is included in e-mails related to the envelope on which it exists. This applies to only specific tabs.

◆ InitialValue

string DocuSign.eSign.Model.TabMetadata.InitialValue

getset

The original value of the tab.

◆ Italic

string DocuSign.eSign.Model.TabMetadata.Italic

getset

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

◆ Items

List<string> DocuSign.eSign.Model.TabMetadata.Items

getset

If the tab is a list, this represents the values that are possible for the tab.

◆ LastModified

string DocuSign.eSign.Model.TabMetadata.LastModified

getset

The UTC DateTime this object was last modified. This is in ISO8601 format.

◆ LastModifiedByDisplayName

string DocuSign.eSign.Model.TabMetadata.LastModifiedByDisplayName

getset

The User Name of the DocuSign user who last modified this object.

◆ LastModifiedByUserId

string DocuSign.eSign.Model.TabMetadata.LastModifiedByUserId

getset

The userId of the DocuSign user who last modified this object.

◆ LocalePolicy

LocalePolicyTab DocuSign.eSign.Model.TabMetadata.LocalePolicy

getset

Reserved for DocuSign.

◆ Locked

string DocuSign.eSign.Model.TabMetadata.Locked

getset

When set to true, the signer cannot change the data of the custom tab.

◆ MaximumLength

string DocuSign.eSign.Model.TabMetadata.MaximumLength

getset

The maximum number of entry characters supported by the custom tab.

◆ MaxNumericalValue

string DocuSign.eSign.Model.TabMetadata.MaxNumericalValue

getset

Gets or Sets MaxNumericalValue

◆ MergeField

MergeField DocuSign.eSign.Model.TabMetadata.MergeField

getset

Contains the information necessary to map the tab to a field in SalesForce.

◆ MinNumericalValue

string DocuSign.eSign.Model.TabMetadata.MinNumericalValue

getset

Gets or Sets MinNumericalValue

◆ Name

string DocuSign.eSign.Model.TabMetadata.Name

getset

Gets or Sets Name

◆ NumericalValue

string DocuSign.eSign.Model.TabMetadata.NumericalValue

getset

Gets or Sets NumericalValue

◆ PaymentItemCode

string DocuSign.eSign.Model.TabMetadata.PaymentItemCode

getset

Gets or Sets PaymentItemCode

◆ PaymentItemDescription

string DocuSign.eSign.Model.TabMetadata.PaymentItemDescription

getset

Gets or Sets PaymentItemDescription

◆ PaymentItemName

string DocuSign.eSign.Model.TabMetadata.PaymentItemName

getset

Gets or Sets PaymentItemName

◆ RequireAll

string DocuSign.eSign.Model.TabMetadata.RequireAll

getset

When set to true and shared is true, information must be entered in this field to complete the envelope.

◆ Required

string DocuSign.eSign.Model.TabMetadata.Required

getset

When set to true, the signer is required to fill out this tab

◆ RequireInitialOnSharedChange

string DocuSign.eSign.Model.TabMetadata.RequireInitialOnSharedChange

getset

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

◆ ScaleValue

string DocuSign.eSign.Model.TabMetadata.ScaleValue

getset

Gets or Sets ScaleValue

◆ Selected

string DocuSign.eSign.Model.TabMetadata.Selected

getset

Gets or Sets Selected

◆ Shared

string DocuSign.eSign.Model.TabMetadata.Shared

getset

When set to true, this custom tab is shared.

◆ SignatureProviderId

string DocuSign.eSign.Model.TabMetadata.SignatureProviderId

getset

Gets or Sets SignatureProviderId

◆ StampType

string DocuSign.eSign.Model.TabMetadata.StampType

getset

Gets or Sets StampType

◆ StampTypeMetadata

PropertyMetadata DocuSign.eSign.Model.TabMetadata.StampTypeMetadata

getset

Metadata that indicates whether the `stampType` property is editable.

◆ TabLabel

string DocuSign.eSign.Model.TabMetadata.TabLabel

getset

The label string associated with the tab.

◆ Type

string DocuSign.eSign.Model.TabMetadata.Type

getset

The type of this tab. Values are: Approve, CheckBox, Company, Date, DateSigned, Decline, Email, EmailAddress, EnvelopeId, FirstName, Formula, FullName, InitialHere, InitialHereOptional, LastName, List, Note, Number, Radio, SignerAttachment, SignHere, SignHereOptional, Ssn, Text, Title, Zip5, or Zip5Dash4.

◆ Underline

string DocuSign.eSign.Model.TabMetadata.Underline

getset

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

◆ ValidationMessage

string DocuSign.eSign.Model.TabMetadata.ValidationMessage

getset

The message displayed if the custom tab fails input validation (either custom of embedded).

◆ ValidationPattern

string DocuSign.eSign.Model.TabMetadata.ValidationPattern

getset

A regular expression used to validate input for the tab.

◆ ValidationType

string DocuSign.eSign.Model.TabMetadata.ValidationType

getset

Gets or Sets ValidationType

◆ Width

string DocuSign.eSign.Model.TabMetadata.Width

getset

Width of the tab in pixels.

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

sdk/src/DocuSign.eSign/Model/TabMetadata.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ TabMetadata()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ Anchor

◆ AnchorCaseSensitive

◆ AnchorHorizontalAlignment

◆ AnchorIgnoreIfNotPresent

◆ AnchorMatchWholeWord

◆ AnchorUnits

◆ AnchorXOffset

◆ AnchorYOffset

◆ Bold

◆ Collaborative

◆ ConcealValueOnDocument

◆ CreatedByDisplayName

◆ CreatedByUserId

◆ CustomTabId

◆ DisableAutoSize

◆ Editable

◆ Font

◆ FontColor

◆ FontSize

◆ Height

◆ IncludedInEmail

◆ InitialValue

◆ Italic

◆ Items

◆ LastModified

◆ LastModifiedByDisplayName

◆ LastModifiedByUserId

◆ LocalePolicy

◆ Locked

◆ MaximumLength

◆ MaxNumericalValue

◆ MergeField

◆ MinNumericalValue

◆ Name

◆ NumericalValue

◆ PaymentItemCode

◆ PaymentItemDescription

◆ PaymentItemName

◆ RequireAll

◆ Required

◆ RequireInitialOnSharedChange

◆ ScaleValue

◆ Selected

◆ Shared

◆ SignatureProviderId

◆ StampType

◆ StampTypeMetadata

◆ TabLabel

◆ Type

◆ Underline

◆ ValidationMessage

◆ ValidationPattern

◆ ValidationType

◆ Width