Holds the properties that define how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide. More...

Inheritance diagram for DocuSign.eSign.Model.DocumentHtmlDefinition:

Public Member Functions
	DocumentHtmlDefinition (string DisplayAnchorPrefix=default(string), List< DocumentHtmlDisplayAnchor > DisplayAnchors=default(List< DocumentHtmlDisplayAnchor >), string DisplayOrder=default(string), string DisplayPageNumber=default(string), string DocumentGuid=default(string), string DocumentId=default(string), string HeaderLabel=default(string), string MaxScreenWidth=default(string), string RemoveEmptyTags=default(string), string ShowMobileOptimizedToggle=default(string), string Source=default(string))
	Initializes a new instance of the DocumentHtmlDefinition 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 (DocumentHtmlDefinition other)
	Returns true if DocumentHtmlDefinition instances are equal More...

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

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

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

List< DocumentHtmlDisplayAnchor >	DisplayAnchors `[get, set]`
	Gets or Sets DisplayAnchors More...

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

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

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

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

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

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

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

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

Detailed Description

Holds the properties that define how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.

Constructor & Destructor Documentation

◆ DocumentHtmlDefinition()

DocuSign.eSign.Model.DocumentHtmlDefinition.DocumentHtmlDefinition	(	string	DisplayAnchorPrefix = `default(string)`,
		List< DocumentHtmlDisplayAnchor >	DisplayAnchors = `default(List<DocumentHtmlDisplayAnchor>)`,
		string	DisplayOrder = `default(string)`,
		string	DisplayPageNumber = `default(string)`,
		string	DocumentGuid = `default(string)`,
		string	DocumentId = `default(string)`,
		string	HeaderLabel = `default(string)`,
		string	MaxScreenWidth = `default(string)`,
		string	RemoveEmptyTags = `default(string)`,
		string	ShowMobileOptimizedToggle = `default(string)`,
		string	Source = `default(string)`
	)

inline

Initializes a new instance of the DocumentHtmlDefinition class.

Parameters

DisplayAnchorPrefix	DisplayAnchorPrefix.
DisplayAnchors	DisplayAnchors.
DisplayOrder	DisplayOrder.
DisplayPageNumber	DisplayPageNumber.
DocumentGuid	DocumentGuid.
DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
HeaderLabel	HeaderLabel.
MaxScreenWidth	MaxScreenWidth.
RemoveEmptyTags	RemoveEmptyTags.
ShowMobileOptimizedToggle	ShowMobileOptimizedToggle.
Source	Source.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if DocumentHtmlDefinition instances are equal

Parameters

other Instance of DocumentHtmlDefinition to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ DisplayAnchorPrefix

string DocuSign.eSign.Model.DocumentHtmlDefinition.DisplayAnchorPrefix

getset

Gets or Sets DisplayAnchorPrefix

◆ DisplayAnchors

List<DocumentHtmlDisplayAnchor> DocuSign.eSign.Model.DocumentHtmlDefinition.DisplayAnchors

getset

Gets or Sets DisplayAnchors

◆ DisplayOrder

string DocuSign.eSign.Model.DocumentHtmlDefinition.DisplayOrder

getset

Gets or Sets DisplayOrder

◆ DisplayPageNumber

string DocuSign.eSign.Model.DocumentHtmlDefinition.DisplayPageNumber

getset

Gets or Sets DisplayPageNumber

◆ DocumentGuid

string DocuSign.eSign.Model.DocumentHtmlDefinition.DocumentGuid

getset

Gets or Sets DocumentGuid

◆ DocumentId

string DocuSign.eSign.Model.DocumentHtmlDefinition.DocumentId

getset

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

◆ HeaderLabel

string DocuSign.eSign.Model.DocumentHtmlDefinition.HeaderLabel

getset

Gets or Sets HeaderLabel

◆ MaxScreenWidth

string DocuSign.eSign.Model.DocumentHtmlDefinition.MaxScreenWidth

getset

Gets or Sets MaxScreenWidth

◆ RemoveEmptyTags

string DocuSign.eSign.Model.DocumentHtmlDefinition.RemoveEmptyTags

getset

Gets or Sets RemoveEmptyTags

◆ ShowMobileOptimizedToggle

string DocuSign.eSign.Model.DocumentHtmlDefinition.ShowMobileOptimizedToggle

getset

Gets or Sets ShowMobileOptimizedToggle

◆ Source

string DocuSign.eSign.Model.DocumentHtmlDefinition.Source

getset

Gets or Sets Source

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ DocumentHtmlDefinition()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ DisplayAnchorPrefix

◆ DisplayAnchors

◆ DisplayOrder

◆ DisplayPageNumber

◆ DocumentGuid

◆ DocumentId

◆ HeaderLabel

◆ MaxScreenWidth

◆ RemoveEmptyTags

◆ ShowMobileOptimizedToggle

◆ Source