A tab that allows the recipient to sign a document. May be optional. More...

Inheritance diagram for DocuSign.eSign.Model.SignHere:

Public Member Functions
	SignHere (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 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 FormOrder=default(string), PropertyMetadata FormOrderMetadata=default(PropertyMetadata), string FormPageLabel=default(string), PropertyMetadata FormPageLabelMetadata=default(PropertyMetadata), string FormPageNumber=default(string), PropertyMetadata FormPageNumberMetadata=default(PropertyMetadata), string HandDrawRequired=default(string), string Height=default(string), PropertyMetadata HeightMetadata=default(PropertyMetadata), string IsSealSignTab=default(string), MergeField MergeField=default(MergeField), string MergeFieldXml=default(string), string Name=default(string), PropertyMetadata NameMetadata=default(PropertyMetadata), string Optional=default(string), PropertyMetadata OptionalMetadata=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 ScaleValue=default(string), PropertyMetadata ScaleValueMetadata=default(PropertyMetadata), SmartContractInformation SmartContractInformation=default(SmartContractInformation), string Source=default(string), Stamp Stamp=default(Stamp), string StampType=default(string), PropertyMetadata StampTypeMetadata=default(PropertyMetadata), 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 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 SignHere 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 (SignHere other)
	Returns true if SignHere 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 `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	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	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	HandDrawRequired `[get, set]`
	Gets or Sets HandDrawRequired 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	IsSealSignTab `[get, set]`
	Gets or Sets IsSealSignTab 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	Optional `[get, set]`
	Gets or Sets Optional More...

PropertyMetadata	OptionalMetadata `[get, set]`
	Metadata that indicates whether the `optional` property is editable. 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	ScaleValue `[get, set]`
	Gets or Sets ScaleValue More...

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

SmartContractInformation	SmartContractInformation `[get, set]`
	Reserved for DocuSign. More...

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

Stamp	Stamp `[get, set]`
	Gets or Sets Stamp 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	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	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...

Detailed Description

A tab that allows the recipient to sign a document. May be optional.

Constructor & Destructor Documentation

◆ SignHere()

DocuSign.eSign.Model.SignHere.SignHere	(	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	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	FormOrder = `default(string)`,
		PropertyMetadata	FormOrderMetadata = `default(PropertyMetadata)`,
		string	FormPageLabel = `default(string)`,
		PropertyMetadata	FormPageLabelMetadata = `default(PropertyMetadata)`,
		string	FormPageNumber = `default(string)`,
		PropertyMetadata	FormPageNumberMetadata = `default(PropertyMetadata)`,
		string	HandDrawRequired = `default(string)`,
		string	Height = `default(string)`,
		PropertyMetadata	HeightMetadata = `default(PropertyMetadata)`,
		string	IsSealSignTab = `default(string)`,
		MergeField	MergeField = `default(MergeField)`,
		string	MergeFieldXml = `default(string)`,
		string	Name = `default(string)`,
		PropertyMetadata	NameMetadata = `default(PropertyMetadata)`,
		string	Optional = `default(string)`,
		PropertyMetadata	OptionalMetadata = `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	ScaleValue = `default(string)`,
		PropertyMetadata	ScaleValueMetadata = `default(PropertyMetadata)`,
		SmartContractInformation	SmartContractInformation = `default(SmartContractInformation)`,
		string	Source = `default(string)`,
		Stamp	Stamp = `default(Stamp)`,
		string	StampType = `default(string)`,
		PropertyMetadata	StampTypeMetadata = `default(PropertyMetadata)`,
		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	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 SignHere class.

Parameters

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..
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..
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..
HandDrawRequired	HandDrawRequired.
Height	Height of the tab in pixels..
HeightMetadata	Metadata that indicates whether the `height` property is editable..
IsSealSignTab	IsSealSignTab.
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..
Optional	Optional.
OptionalMetadata	Metadata that indicates whether the `optional` property is editable..
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..
ScaleValue	ScaleValue.
ScaleValueMetadata	Metadata that indicates whether the `scaleValue` property is editable..
SmartContractInformation	Reserved for DocuSign..
Source	Source.
Stamp	Stamp.
StampType	StampType.
StampTypeMetadata	Metadata that indicates whether the `stampType` property is editable..
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..
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..

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.SignHere.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.SignHere.Equals ( SignHere other )

inline

Returns true if SignHere instances are equal

Parameters

other Instance of SignHere to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnchorAllowWhiteSpaceInCharacters

string DocuSign.eSign.Model.SignHere.AnchorAllowWhiteSpaceInCharacters

getset

Gets or Sets AnchorAllowWhiteSpaceInCharacters

◆ AnchorAllowWhiteSpaceInCharactersMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorAllowWhiteSpaceInCharactersMetadata

getset

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

◆ AnchorCaseSensitive

string DocuSign.eSign.Model.SignHere.AnchorCaseSensitive

getset

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

getset

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

◆ AnchorHorizontalAlignment

string DocuSign.eSign.Model.SignHere.AnchorHorizontalAlignment

getset

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

getset

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

◆ AnchorIgnoreIfNotPresent

string DocuSign.eSign.Model.SignHere.AnchorIgnoreIfNotPresent

getset

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

◆ AnchorIgnoreIfNotPresentMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorIgnoreIfNotPresentMetadata

getset

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

◆ AnchorMatchWholeWord

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

◆ AnchorMatchWholeWordMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorMatchWholeWordMetadata

getset

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

◆ AnchorString

string DocuSign.eSign.Model.SignHere.AnchorString

getset

Anchor text information for a radio button.

◆ AnchorStringMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorStringMetadata

getset

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

◆ AnchorTabProcessorVersion

string DocuSign.eSign.Model.SignHere.AnchorTabProcessorVersion

getset

Gets or Sets AnchorTabProcessorVersion

◆ AnchorTabProcessorVersionMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorTabProcessorVersionMetadata

getset

Reserved for DocuSign.

◆ AnchorUnits

string DocuSign.eSign.Model.SignHere.AnchorUnits

getset

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

◆ AnchorUnitsMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorUnitsMetadata

getset

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

◆ AnchorXOffset

string DocuSign.eSign.Model.SignHere.AnchorXOffset

getset

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

◆ AnchorXOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorXOffsetMetadata

getset

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

◆ AnchorYOffset

string DocuSign.eSign.Model.SignHere.AnchorYOffset

getset

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

◆ AnchorYOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.AnchorYOffsetMetadata

getset

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

◆ Caption

string DocuSign.eSign.Model.SignHere.Caption

getset

Gets or Sets Caption

◆ CaptionMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.CaptionMetadata

getset

Gets or Sets CaptionMetadata

◆ ConditionalParentLabel

string DocuSign.eSign.Model.SignHere.ConditionalParentLabel

getset

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

◆ ConditionalParentLabelMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.ConditionalParentLabelMetadata

getset

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

◆ ConditionalParentValue

string DocuSign.eSign.Model.SignHere.ConditionalParentValue

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.

◆ ConditionalParentValueMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.ConditionalParentValueMetadata

getset

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

◆ CustomTabId

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

◆ CustomTabIdMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.CustomTabIdMetadata

getset

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

◆ DocumentId

string DocuSign.eSign.Model.SignHere.DocumentId

getset

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

◆ DocumentIdMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.DocumentIdMetadata

getset

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

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.SignHere.ErrorDetails

getset

Array or errors.

◆ FormOrder

string DocuSign.eSign.Model.SignHere.FormOrder

getset

Gets or Sets FormOrder

◆ FormOrderMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.FormOrderMetadata

getset

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

◆ FormPageLabel

string DocuSign.eSign.Model.SignHere.FormPageLabel

getset

Gets or Sets FormPageLabel

◆ FormPageLabelMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.FormPageLabelMetadata

getset

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

◆ FormPageNumber

string DocuSign.eSign.Model.SignHere.FormPageNumber

getset

Gets or Sets FormPageNumber

◆ FormPageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.FormPageNumberMetadata

getset

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

◆ HandDrawRequired

string DocuSign.eSign.Model.SignHere.HandDrawRequired

getset

Gets or Sets HandDrawRequired

◆ Height

string DocuSign.eSign.Model.SignHere.Height

getset

Height of the tab in pixels.

◆ HeightMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.HeightMetadata

getset

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

◆ IsSealSignTab

string DocuSign.eSign.Model.SignHere.IsSealSignTab

getset

Gets or Sets IsSealSignTab

◆ MergeField

MergeField DocuSign.eSign.Model.SignHere.MergeField

getset

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

◆ MergeFieldXml

string DocuSign.eSign.Model.SignHere.MergeFieldXml

getset

Gets or Sets MergeFieldXml

◆ Name

string DocuSign.eSign.Model.SignHere.Name

getset

Specifies the tool tip text for the tab.

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.NameMetadata

getset

Metadata that indicates whether the `name` property is editable. This property is read-only.

◆ Optional

string DocuSign.eSign.Model.SignHere.Optional

getset

Gets or Sets Optional

◆ OptionalMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.OptionalMetadata

getset

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

◆ PageNumber

string DocuSign.eSign.Model.SignHere.PageNumber

getset

Specifies the page number on which the tab is located.

◆ PageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.PageNumberMetadata

getset

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

◆ RecipientId

string DocuSign.eSign.Model.SignHere.RecipientId

getset

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

getset

Gets or Sets RecipientIdGuid

◆ RecipientIdGuidMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.RecipientIdGuidMetadata

getset

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

◆ RecipientIdMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.RecipientIdMetadata

getset

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

◆ ScaleValue

string DocuSign.eSign.Model.SignHere.ScaleValue

getset

Gets or Sets ScaleValue

◆ ScaleValueMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.ScaleValueMetadata

getset

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

◆ SmartContractInformation

SmartContractInformation DocuSign.eSign.Model.SignHere.SmartContractInformation

getset

Reserved for DocuSign.

◆ Source

string DocuSign.eSign.Model.SignHere.Source

getset

Gets or Sets Source

◆ Stamp

Stamp DocuSign.eSign.Model.SignHere.Stamp

getset

Gets or Sets Stamp

◆ StampType

string DocuSign.eSign.Model.SignHere.StampType

getset

Gets or Sets StampType

◆ StampTypeMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.StampTypeMetadata

getset

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

◆ Status

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

◆ StatusMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.StatusMetadata

getset

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

◆ TabGroupLabels

List<string> DocuSign.eSign.Model.SignHere.TabGroupLabels

getset

Gets or Sets TabGroupLabels

◆ TabGroupLabelsMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TabGroupLabelsMetadata

getset

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

◆ TabId

string DocuSign.eSign.Model.SignHere.TabId

getset

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call].

◆ TabIdMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TabIdMetadata

getset

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

◆ TabLabel

string DocuSign.eSign.Model.SignHere.TabLabel

getset

The label string associated with the tab.

◆ TabLabelMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TabLabelMetadata

getset

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

◆ TabOrder

string DocuSign.eSign.Model.SignHere.TabOrder

getset

Gets or Sets TabOrder

◆ TabOrderMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TabOrderMetadata

getset

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

◆ TabType

string DocuSign.eSign.Model.SignHere.TabType

getset

Gets or Sets TabType

◆ TabTypeMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TabTypeMetadata

getset

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

◆ TemplateLocked

string DocuSign.eSign.Model.SignHere.TemplateLocked

getset

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

getset

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

◆ TemplateRequired

string DocuSign.eSign.Model.SignHere.TemplateRequired

getset

When set to true, the sender may not remove the recipient. Used only when working with template recipients.

◆ TemplateRequiredMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.TemplateRequiredMetadata

getset

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

◆ Tooltip

string DocuSign.eSign.Model.SignHere.Tooltip

getset

Gets or Sets Tooltip

◆ ToolTipMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.ToolTipMetadata

getset

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

◆ Width

string DocuSign.eSign.Model.SignHere.Width

getset

Width of the tab in pixels.

◆ WidthMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.WidthMetadata

getset

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

◆ XPosition

string DocuSign.eSign.Model.SignHere.XPosition

getset

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

◆ XPositionMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.XPositionMetadata

getset

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

◆ YPosition

string DocuSign.eSign.Model.SignHere.YPosition

getset

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

◆ YPositionMetadata

PropertyMetadata DocuSign.eSign.Model.SignHere.YPositionMetadata

getset

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

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ SignHere()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ AnchorAllowWhiteSpaceInCharacters

◆ AnchorAllowWhiteSpaceInCharactersMetadata

◆ AnchorCaseSensitive

◆ AnchorCaseSensitiveMetadata

◆ AnchorHorizontalAlignment

◆ AnchorHorizontalAlignmentMetadata

◆ AnchorIgnoreIfNotPresent

◆ AnchorIgnoreIfNotPresentMetadata

◆ AnchorMatchWholeWord

◆ AnchorMatchWholeWordMetadata

◆ AnchorString

◆ AnchorStringMetadata

◆ AnchorTabProcessorVersion

◆ AnchorTabProcessorVersionMetadata

◆ AnchorUnits

◆ AnchorUnitsMetadata

◆ AnchorXOffset

◆ AnchorXOffsetMetadata

◆ AnchorYOffset

◆ AnchorYOffsetMetadata

◆ Caption

◆ CaptionMetadata

◆ ConditionalParentLabel

◆ ConditionalParentLabelMetadata

◆ ConditionalParentValue

◆ ConditionalParentValueMetadata

◆ CustomTabId

◆ CustomTabIdMetadata

◆ DocumentId

◆ DocumentIdMetadata

◆ ErrorDetails

◆ FormOrder

◆ FormOrderMetadata

◆ FormPageLabel

◆ FormPageLabelMetadata

◆ FormPageNumber

◆ FormPageNumberMetadata

◆ HandDrawRequired

◆ Height

◆ HeightMetadata

◆ IsSealSignTab

◆ MergeField

◆ MergeFieldXml

◆ Name

◆ NameMetadata

◆ Optional

◆ OptionalMetadata

◆ PageNumber

◆ PageNumberMetadata

◆ RecipientId

◆ RecipientIdGuid

◆ RecipientIdGuidMetadata

◆ RecipientIdMetadata

◆ ScaleValue

◆ ScaleValueMetadata

◆ SmartContractInformation

◆ Source

◆ Stamp

◆ StampType

◆ StampTypeMetadata

◆ Status

◆ StatusMetadata

◆ TabGroupLabels

◆ TabGroupLabelsMetadata

◆ TabId

◆ TabIdMetadata

◆ TabLabel

◆ TabLabelMetadata