A tab that allows the recipient to enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information. More...

Inheritance diagram for DocuSign.eSign.Model.Zip:

Public Member Functions
	Zip (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 ConcealValueOnDocument=default(string), PropertyMetadata ConcealValueOnDocumentMetadata=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 DisableAutoSize=default(string), PropertyMetadata DisableAutoSizeMetadata=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), LocalePolicyTab LocalePolicy=default(LocalePolicyTab), string Locked=default(string), PropertyMetadata LockedMetadata=default(PropertyMetadata), string MaxLength=default(string), PropertyMetadata MaxLengthMetadata=default(PropertyMetadata), MergeField MergeField=default(MergeField), string MergeFieldXml=default(string), string Name=default(string), PropertyMetadata NameMetadata=default(PropertyMetadata), string OriginalValue=default(string), PropertyMetadata OriginalValueMetadata=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 RequireAll=default(string), PropertyMetadata RequireAllMetadata=default(PropertyMetadata), string Required=default(string), PropertyMetadata RequiredMetadata=default(PropertyMetadata), string RequireInitialOnSharedChange=default(string), PropertyMetadata RequireInitialOnSharedChangeMetadata=default(PropertyMetadata), string SenderRequired=default(string), PropertyMetadata SenderRequiredMetadata=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 UseDash4=default(string), PropertyMetadata UseDash4Metadata=default(PropertyMetadata), string ValidationMessage=default(string), PropertyMetadata ValidationMessageMetadata=default(PropertyMetadata), string ValidationPattern=default(string), PropertyMetadata ValidationPatternMetadata=default(PropertyMetadata), string Value=default(string), PropertyMetadata ValueMetadata=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 Zip 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 (Zip other)
	Returns true if Zip 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	Bold `[get, set]`
	When set to true, the information in the tab is bold. More...

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

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

PropertyMetadata	CaptionMetadata `[get, set]`
	Gets or Sets CaptionMetadata More...

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

PropertyMetadata	ConcealValueOnDocumentMetadata `[get, set]`
	Metadata that indicates whether the `concealValueOnDocument` property is editable. 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	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...

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

string	DocumentId `[get, set]`
	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. More...

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

ErrorDetails	ErrorDetails `[get, set]`
	Array or errors. More...

string	Font `[get, set]`
	The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. More...

string	FontColor `[get, set]`
	The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. More...

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

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

string	FontSize `[get, set]`
	The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. More...

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

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

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

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

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

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

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

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

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

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

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

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

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

string	MaxLength `[get, set]`
	An optional value that describes the maximum length of the property when the property is a string. More...

PropertyMetadata	MaxLengthMetadata `[get, set]`
	Metadata that indicates whether the `maxLength` 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]`
	Gets or Sets Name More...

PropertyMetadata	NameMetadata `[get, set]`
	Metadata that indicates whether the `name` property is editable. This property is read-only. More...

string	OriginalValue `[get, set]`
	The initial value of the tab when it was sent to the recipient. More...

PropertyMetadata	OriginalValueMetadata `[get, set]`
	Metadata that indicates whether the `originalValue` 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	RequireAll `[get, set]`
	When set to true and shared is true, information must be entered in this field to complete the envelope. More...

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

string	Required `[get, set]`
	When set to true, the signer is required to fill out this tab More...

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

string	RequireInitialOnSharedChange `[get, set]`
	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. More...

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

string	SenderRequired `[get, set]`
	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope. More...

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

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

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

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

PropertyMetadata	ShareToRecipientsMetadata `[get, set]`
	Reserved for DocuSign. More...

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

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

string	Status `[get, set]`
	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later. More...

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

List< string >	TabGroupLabels `[get, set]`
	Gets or Sets TabGroupLabels More...

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

string	TabId `[get, set]`
	The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. More...

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

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

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

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

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

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

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

string	TemplateLocked `[get, set]`
	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. More...

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

string	TemplateRequired `[get, set]`
	When set to true, the sender may not remove the recipient. Used only when working with template recipients. More...

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

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

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

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

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

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

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

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

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

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

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

string	Value `[get, set]`
	Specifies the value of the tab. More...

PropertyMetadata	ValueMetadata `[get, set]`
	Metadata that indicates whether the `value` 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 enter a ZIP code. The ZIP code can be five digits or nine digits in the ZIP+4 format. The zip code can be typed with or without dashes. It uses the same parameters as a Text tab, with the validation message and pattern set for ZIP code information.

Constructor & Destructor Documentation

◆ Zip()

DocuSign.eSign.Model.Zip.Zip	(	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	ConcealValueOnDocument = `default(string)`,
		PropertyMetadata	ConcealValueOnDocumentMetadata = `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	DisableAutoSize = `default(string)`,
		PropertyMetadata	DisableAutoSizeMetadata = `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)`,
		LocalePolicyTab	LocalePolicy = `default(LocalePolicyTab)`,
		string	Locked = `default(string)`,
		PropertyMetadata	LockedMetadata = `default(PropertyMetadata)`,
		string	MaxLength = `default(string)`,
		PropertyMetadata	MaxLengthMetadata = `default(PropertyMetadata)`,
		MergeField	MergeField = `default(MergeField)`,
		string	MergeFieldXml = `default(string)`,
		string	Name = `default(string)`,
		PropertyMetadata	NameMetadata = `default(PropertyMetadata)`,
		string	OriginalValue = `default(string)`,
		PropertyMetadata	OriginalValueMetadata = `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	RequireAll = `default(string)`,
		PropertyMetadata	RequireAllMetadata = `default(PropertyMetadata)`,
		string	Required = `default(string)`,
		PropertyMetadata	RequiredMetadata = `default(PropertyMetadata)`,
		string	RequireInitialOnSharedChange = `default(string)`,
		PropertyMetadata	RequireInitialOnSharedChangeMetadata = `default(PropertyMetadata)`,
		string	SenderRequired = `default(string)`,
		PropertyMetadata	SenderRequiredMetadata = `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	UseDash4 = `default(string)`,
		PropertyMetadata	UseDash4Metadata = `default(PropertyMetadata)`,
		string	ValidationMessage = `default(string)`,
		PropertyMetadata	ValidationMessageMetadata = `default(PropertyMetadata)`,
		string	ValidationPattern = `default(string)`,
		PropertyMetadata	ValidationPatternMetadata = `default(PropertyMetadata)`,
		string	Value = `default(string)`,
		PropertyMetadata	ValueMetadata = `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 Zip 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..
Bold	When set to true, the information in the tab is bold..
BoldMetadata	Metadata that indicates whether the `bold` property is editable..
Caption	Caption.
CaptionMetadata	CaptionMetadata.
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..
ConcealValueOnDocumentMetadata	Metadata that indicates whether the `concealValueOnDocument` property is editable..
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..
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..
DisableAutoSizeMetadata	Metadata that indicates whether the `disableAutoSize` property is editable..
DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
DocumentIdMetadata	Metadata that indicates whether the `documentId` property is editable..
ErrorDetails	Array or errors..
Font	The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default..
FontColor	The font color used for the information in the tab. Possible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White..
FontColorMetadata	Metadata that indicates whether the `fontColor` property is editable..
FontMetadata	Metadata that indicates whether the `font` property is editable..
FontSize	The font size used for the information in the tab. Possible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72..
FontSizeMetadata	Metadata that indicates whether the `fontSize` property is editable..
FormOrder	FormOrder.
FormOrderMetadata	Metadata that indicates whether the `formOrder` property is editable..
FormPageLabel	FormPageLabel.
FormPageLabelMetadata	Metadata that indicates whether the `formPageLabel` property is editable..
FormPageNumber	FormPageNumber.
FormPageNumberMetadata	Metadata that indicates whether the `fromPageNumber` property is editable..
Height	Height of the tab in pixels..
HeightMetadata	Metadata that indicates whether the `height` property is editable..
Italic	When set to true, the information in the tab is italic..
ItalicMetadata	Metadata that indicates whether the `italic` property is editable..
LocalePolicy	Reserved for DocuSign..
Locked	When set to true, the signer cannot change the data of the custom tab..
LockedMetadata	Metadata that indicates whether the `locked` property is editable..
MaxLength	An optional value that describes the maximum length of the property when the property is a string..
MaxLengthMetadata	Metadata that indicates whether the `maxLength` property is editable..
MergeField	Contains the information necessary to map the tab to a field in SalesForce..
MergeFieldXml	MergeFieldXml.
Name	Name.
NameMetadata	Metadata that indicates whether the `name` property is editable. This property is read-only..
OriginalValue	The initial value of the tab when it was sent to the recipient. .
OriginalValueMetadata	Metadata that indicates whether the `originalValue` 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..
RequireAll	When set to true and shared is true, information must be entered in this field to complete the envelope. .
RequireAllMetadata	Metadata that indicates whether the `requireAll` property is editable..
Required	When set to true, the signer is required to fill out this tab.
RequiredMetadata	Metadata that indicates whether the `required` property is editable..
RequireInitialOnSharedChange	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field..
RequireInitialOnSharedChangeMetadata	Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
SenderRequired	When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope..
SenderRequiredMetadata	Metadata that indicates whether the `senderRequired` property is editable..
Shared	When set to true, this custom tab is shared..
SharedMetadata	Metadata that indicates whether the `shared` property is editable..
ShareToRecipients	ShareToRecipients.
ShareToRecipientsMetadata	Reserved for DocuSign..
SmartContractInformation	Reserved for DocuSign..
Source	Source.
Status	Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients. * created - The envelope is saved as a draft and can be modified and sent later..
StatusMetadata	Metadata that indicates whether the `status` property is editable..
TabGroupLabels	TabGroupLabels.
TabGroupLabelsMetadata	Metadata that indicates whether the `tabGroupLabels` property is editable..
TabId	The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. .
TabIdMetadata	Metadata that indicates whether the `tabId` property is editable..
TabLabel	The label string associated with the tab..
TabLabelMetadata	Metadata that indicates whether the `tabLabel` property is editable..
TabOrder	TabOrder.
TabOrderMetadata	Metadata that indicates whether the `tabOrder` property is editable..
TabType	TabType.
TabTypeMetadata	Metadata that indicates whether the `tabType` property is editable..
TemplateLocked	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateLockedMetadata	Metadata that indicates whether the `templateLocked` property is editable..
TemplateRequired	When set to true, the sender may not remove the recipient. Used only when working with template recipients..
TemplateRequiredMetadata	Metadata that indicates whether the `templateRequired` property is editable..
Tooltip	Tooltip.
ToolTipMetadata	Metadata that indicates whether the `toolTip` property is editable..
Underline	When set to true, the information in the tab is underlined..
UnderlineMetadata	Metadata that indicates whether the `underline` property is editable..
UseDash4	UseDash4.
UseDash4Metadata	Metadata that indicates whether the `useDash4` property is editable..
ValidationMessage	The message displayed if the custom tab fails input validation (either custom of embedded)..
ValidationMessageMetadata	Metadata that indicates whether the `validationMessage` property is editable..
ValidationPattern	A regular expression used to validate input for the tab..
ValidationPatternMetadata	Metadata that indicates whether the `validationPattern` property is editable..
Value	Specifies the value of the tab. .
ValueMetadata	Metadata that indicates whether the `value` 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.Zip.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.Zip.Equals ( Zip other )

inline

Returns true if Zip instances are equal

Parameters

other Instance of Zip to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ AnchorAllowWhiteSpaceInCharacters

string DocuSign.eSign.Model.Zip.AnchorAllowWhiteSpaceInCharacters

getset

Gets or Sets AnchorAllowWhiteSpaceInCharacters

◆ AnchorAllowWhiteSpaceInCharactersMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorAllowWhiteSpaceInCharactersMetadata

getset

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

◆ AnchorCaseSensitive

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

getset

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

◆ AnchorHorizontalAlignment

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

getset

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

◆ AnchorIgnoreIfNotPresent

string DocuSign.eSign.Model.Zip.AnchorIgnoreIfNotPresent

getset

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

◆ AnchorIgnoreIfNotPresentMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorIgnoreIfNotPresentMetadata

getset

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

◆ AnchorMatchWholeWord

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

getset

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

◆ AnchorString

string DocuSign.eSign.Model.Zip.AnchorString

getset

Anchor text information for a radio button.

◆ AnchorStringMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorStringMetadata

getset

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

◆ AnchorTabProcessorVersion

string DocuSign.eSign.Model.Zip.AnchorTabProcessorVersion

getset

Gets or Sets AnchorTabProcessorVersion

◆ AnchorTabProcessorVersionMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorTabProcessorVersionMetadata

getset

Reserved for DocuSign.

◆ AnchorUnits

string DocuSign.eSign.Model.Zip.AnchorUnits

getset

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

◆ AnchorUnitsMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorUnitsMetadata

getset

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

◆ AnchorXOffset

string DocuSign.eSign.Model.Zip.AnchorXOffset

getset

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

◆ AnchorXOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorXOffsetMetadata

getset

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

◆ AnchorYOffset

string DocuSign.eSign.Model.Zip.AnchorYOffset

getset

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

◆ AnchorYOffsetMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.AnchorYOffsetMetadata

getset

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

◆ Bold

string DocuSign.eSign.Model.Zip.Bold

getset

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

◆ BoldMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.BoldMetadata

getset

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

◆ Caption

string DocuSign.eSign.Model.Zip.Caption

getset

Gets or Sets Caption

◆ CaptionMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.CaptionMetadata

getset

Gets or Sets CaptionMetadata

◆ ConcealValueOnDocument

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

◆ ConcealValueOnDocumentMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ConcealValueOnDocumentMetadata

getset

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

◆ ConditionalParentLabel

string DocuSign.eSign.Model.Zip.ConditionalParentLabel

getset

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

◆ ConditionalParentLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ConditionalParentLabelMetadata

getset

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

◆ ConditionalParentValue

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

getset

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

◆ CustomTabId

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

getset

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

◆ DisableAutoSize

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

◆ DisableAutoSizeMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.DisableAutoSizeMetadata

getset

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

◆ DocumentId

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

getset

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

◆ ErrorDetails

ErrorDetails DocuSign.eSign.Model.Zip.ErrorDetails

getset

Array or errors.

◆ Font

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

◆ FontColorMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FontColorMetadata

getset

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

◆ FontMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FontMetadata

getset

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

◆ FontSize

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

◆ FontSizeMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FontSizeMetadata

getset

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

◆ FormOrder

string DocuSign.eSign.Model.Zip.FormOrder

getset

Gets or Sets FormOrder

◆ FormOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FormOrderMetadata

getset

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

◆ FormPageLabel

string DocuSign.eSign.Model.Zip.FormPageLabel

getset

Gets or Sets FormPageLabel

◆ FormPageLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FormPageLabelMetadata

getset

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

◆ FormPageNumber

string DocuSign.eSign.Model.Zip.FormPageNumber

getset

Gets or Sets FormPageNumber

◆ FormPageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.FormPageNumberMetadata

getset

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

◆ Height

string DocuSign.eSign.Model.Zip.Height

getset

Height of the tab in pixels.

◆ HeightMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.HeightMetadata

getset

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

◆ Italic

string DocuSign.eSign.Model.Zip.Italic

getset

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

◆ ItalicMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ItalicMetadata

getset

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

◆ LocalePolicy

LocalePolicyTab DocuSign.eSign.Model.Zip.LocalePolicy

getset

Reserved for DocuSign.

◆ Locked

string DocuSign.eSign.Model.Zip.Locked

getset

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

◆ LockedMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.LockedMetadata

getset

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

◆ MaxLength

string DocuSign.eSign.Model.Zip.MaxLength

getset

An optional value that describes the maximum length of the property when the property is a string.

◆ MaxLengthMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.MaxLengthMetadata

getset

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

◆ MergeField

MergeField DocuSign.eSign.Model.Zip.MergeField

getset

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

◆ MergeFieldXml

string DocuSign.eSign.Model.Zip.MergeFieldXml

getset

Gets or Sets MergeFieldXml

◆ Name

string DocuSign.eSign.Model.Zip.Name

getset

Gets or Sets Name

◆ NameMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.NameMetadata

getset

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

◆ OriginalValue

string DocuSign.eSign.Model.Zip.OriginalValue

getset

The initial value of the tab when it was sent to the recipient.

◆ OriginalValueMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.OriginalValueMetadata

getset

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

◆ PageNumber

string DocuSign.eSign.Model.Zip.PageNumber

getset

Specifies the page number on which the tab is located.

◆ PageNumberMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.PageNumberMetadata

getset

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

◆ RecipientId

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

getset

Gets or Sets RecipientIdGuid

◆ RecipientIdGuidMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.RecipientIdGuidMetadata

getset

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

◆ RecipientIdMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.RecipientIdMetadata

getset

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

◆ RequireAll

string DocuSign.eSign.Model.Zip.RequireAll

getset

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

◆ RequireAllMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.RequireAllMetadata

getset

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

◆ Required

string DocuSign.eSign.Model.Zip.Required

getset

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

◆ RequiredMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.RequiredMetadata

getset

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

◆ RequireInitialOnSharedChange

string DocuSign.eSign.Model.Zip.RequireInitialOnSharedChange

getset

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

getset

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

◆ SenderRequired

string DocuSign.eSign.Model.Zip.SenderRequired

getset

When set to true, the sender must populate the tab before an envelope can be sent using the template. This value tab can only be changed by modifying (PUT) the template. Tabs with a `senderRequired` value of true cannot be deleted from an envelope.

◆ SenderRequiredMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.SenderRequiredMetadata

getset

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

◆ Shared

string DocuSign.eSign.Model.Zip.Shared

getset

When set to true, this custom tab is shared.

◆ SharedMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.SharedMetadata

getset

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

◆ ShareToRecipients

string DocuSign.eSign.Model.Zip.ShareToRecipients

getset

Gets or Sets ShareToRecipients

◆ ShareToRecipientsMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ShareToRecipientsMetadata

getset

Reserved for DocuSign.

◆ SmartContractInformation

SmartContractInformation DocuSign.eSign.Model.Zip.SmartContractInformation

getset

Reserved for DocuSign.

◆ Source

string DocuSign.eSign.Model.Zip.Source

getset

Gets or Sets Source

◆ Status

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

getset

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

◆ TabGroupLabels

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

getset

Gets or Sets TabGroupLabels

◆ TabGroupLabelsMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.TabGroupLabelsMetadata

getset

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

◆ TabId

string DocuSign.eSign.Model.Zip.TabId

getset

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

◆ TabIdMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.TabIdMetadata

getset

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

◆ TabLabel

string DocuSign.eSign.Model.Zip.TabLabel

getset

The label string associated with the tab.

◆ TabLabelMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.TabLabelMetadata

getset

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

◆ TabOrder

string DocuSign.eSign.Model.Zip.TabOrder

getset

Gets or Sets TabOrder

◆ TabOrderMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.TabOrderMetadata

getset

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

◆ TabType

string DocuSign.eSign.Model.Zip.TabType

getset

Gets or Sets TabType

◆ TabTypeMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.TabTypeMetadata

getset

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

◆ TemplateLocked

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

getset

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

◆ TemplateRequired

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

getset

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

◆ Tooltip

string DocuSign.eSign.Model.Zip.Tooltip

getset

Gets or Sets Tooltip

◆ ToolTipMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ToolTipMetadata

getset

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

◆ Underline

string DocuSign.eSign.Model.Zip.Underline

getset

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

◆ UnderlineMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.UnderlineMetadata

getset

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

◆ UseDash4

string DocuSign.eSign.Model.Zip.UseDash4

getset

Gets or Sets UseDash4

◆ UseDash4Metadata

PropertyMetadata DocuSign.eSign.Model.Zip.UseDash4Metadata

getset

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

◆ ValidationMessage

string DocuSign.eSign.Model.Zip.ValidationMessage

getset

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

◆ ValidationMessageMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ValidationMessageMetadata

getset

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

◆ ValidationPattern

string DocuSign.eSign.Model.Zip.ValidationPattern

getset

A regular expression used to validate input for the tab.

◆ ValidationPatternMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ValidationPatternMetadata

getset

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

◆ Value

string DocuSign.eSign.Model.Zip.Value

getset

Specifies the value of the tab.

◆ ValueMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.ValueMetadata

getset

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

◆ Width

string DocuSign.eSign.Model.Zip.Width

getset

Width of the tab in pixels.

◆ WidthMetadata

PropertyMetadata DocuSign.eSign.Model.Zip.WidthMetadata

getset

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

◆ XPosition

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

getset

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

◆ YPosition

string DocuSign.eSign.Model.Zip.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.Zip.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/Zip.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ Zip()

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

◆ Bold

◆ BoldMetadata

◆ Caption

◆ CaptionMetadata

◆ ConcealValueOnDocument

◆ ConcealValueOnDocumentMetadata

◆ ConditionalParentLabel

◆ ConditionalParentLabelMetadata

◆ ConditionalParentValue

◆ ConditionalParentValueMetadata

◆ CustomTabId

◆ CustomTabIdMetadata

◆ DisableAutoSize

◆ DisableAutoSizeMetadata

◆ DocumentId

◆ DocumentIdMetadata

◆ ErrorDetails

◆ Font

◆ FontColor

◆ FontColorMetadata

◆ FontMetadata

◆ FontSize

◆ FontSizeMetadata

◆ FormOrder

◆ FormOrderMetadata

◆ FormPageLabel

◆ FormPageLabelMetadata

◆ FormPageNumber

◆ FormPageNumberMetadata

◆ Height

◆ HeightMetadata

◆ Italic

◆ ItalicMetadata

◆ LocalePolicy

◆ Locked

◆ LockedMetadata

◆ MaxLength

◆ MaxLengthMetadata

◆ MergeField

◆ MergeFieldXml

◆ Name

◆ NameMetadata

◆ OriginalValue

◆ OriginalValueMetadata

◆ PageNumber

◆ PageNumberMetadata

◆ RecipientId

◆ RecipientIdGuid