This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/ More...

Inheritance diagram for DocuSign.eSign.Model.CompositeTemplate:

Public Member Functions
	CompositeTemplate (string CompositeTemplateId=default(string), Document Document=default(Document), List< InlineTemplate > InlineTemplates=default(List< InlineTemplate >), string PdfMetaDataTemplateSequence=default(string), List< ServerTemplate > ServerTemplates=default(List< ServerTemplate >))
	Initializes a new instance of the CompositeTemplate 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 (CompositeTemplate other)
	Returns true if CompositeTemplate instances are equal More...

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

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	CompositeTemplateId `[get, set]`
	The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document. More...

Document	Document `[get, set]`
	An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically. More...

List< InlineTemplate >	InlineTemplates `[get, set]`
	Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value. More...

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

List< ServerTemplate >	ServerTemplates `[get, set]`
	0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value More...

Detailed Description

This object contains information about a [composite template][composite], which you can use to to apply multiple templates to a single envelope, combine templates with PDF forms, and combine templates with documents from cloud sources. [composite]: /docs/esign-rest-api/esign101/concepts/templates/composite/

Constructor & Destructor Documentation

◆ CompositeTemplate()

DocuSign.eSign.Model.CompositeTemplate.CompositeTemplate	(	string	CompositeTemplateId = `default(string)`,
		Document	Document = `default(Document)`,
		List< InlineTemplate >	InlineTemplates = `default(List<InlineTemplate>)`,
		string	PdfMetaDataTemplateSequence = `default(string)`,
		List< ServerTemplate >	ServerTemplates = `default(List<ServerTemplate>)`
	)

inline

Initializes a new instance of the CompositeTemplate class.

Parameters

CompositeTemplateId	The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document..
Document	An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically..
InlineTemplates	Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value..
PdfMetaDataTemplateSequence	PdfMetaDataTemplateSequence.
ServerTemplates	0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if CompositeTemplate instances are equal

Parameters

other Instance of CompositeTemplate to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ CompositeTemplateId

string DocuSign.eSign.Model.CompositeTemplate.CompositeTemplateId

getset

The identify of this composite template. It is used as a reference when adding document object information. If used, the document's `content-disposition` must include the composite template ID to which the document should be added. If a composite template ID is not specified in the content-disposition, the document is applied based on the value of the `documentId` property only. If no document object is specified, the composite template inherits the first document.

◆ Document

Document DocuSign.eSign.Model.CompositeTemplate.Document

getset

An optional document object that will act as the primary document in the composite template object. If the document node is present, it will take precedence over any server template or inline template documents. It always comes first. Only use this when you want to supply the document dynamically.

◆ InlineTemplates

List<InlineTemplate> DocuSign.eSign.Model.CompositeTemplate.InlineTemplates

getset

Zero or more inline templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value.

◆ PdfMetaDataTemplateSequence

string DocuSign.eSign.Model.CompositeTemplate.PdfMetaDataTemplateSequence

getset

Gets or Sets PdfMetaDataTemplateSequence

◆ ServerTemplates

List<ServerTemplate> DocuSign.eSign.Model.CompositeTemplate.ServerTemplates

getset

0 or more server-side templates and their position in the overlay. If supplied, they are overlaid into the envelope in the order of their Sequence value

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

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

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ CompositeTemplate()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ CompositeTemplateId

◆ Document

◆ InlineTemplates

◆ PdfMetaDataTemplateSequence

◆ ServerTemplates