Docusign CSharp Docs
Public Member Functions | Properties | List of all members
DocuSign.eSign.Model.Document Class Reference

A document object. More...

Inheritance diagram for DocuSign.eSign.Model.Document:

Public Member Functions

 Document (string ApplyAnchorTabs=default(string), string AssignTabsToRecipientId=default(string), bool? AuthoritativeCopy=default(bool?), string Display=default(string), List< DocGenFormField > DocGenFormFields=default(List< DocGenFormField >), string DocumentBase64=default(string), List< NameValue > DocumentFields=default(List< NameValue >), string DocumentId=default(string), string EncryptedWithKeyManager=default(string), string FileExtension=default(string), string FileFormatHint=default(string), DocumentHtmlDefinition HtmlDefinition=default(DocumentHtmlDefinition), string IncludeInDownload=default(string), string IsDocGenDocument=default(string), List< MatchBox > MatchBoxes=default(List< MatchBox >), string Name=default(string), string Order=default(string), string Pages=default(string), string Password=default(string), string PdfFormFieldOption=default(string), string RemoteUrl=default(string), string SignerMustAcknowledge=default(string), bool? SignerMustAcknowledgeUseAccountDefault=default(bool?), Tabs Tabs=default(Tabs), string TemplateLocked=default(string), string TemplateRequired=default(string), string TransformPdfFields=default(string), string Uri=default(string))
 Initializes a new instance of the Document 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 (Document other)
 Returns true if Document instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string ApplyAnchorTabs [get, set]
 Reserved: TBD More...
 
string AssignTabsToRecipientId [get, set]
 Gets or Sets AssignTabsToRecipientId More...
 
bool AuthoritativeCopy [get, set]
 Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled. More...
 
string Display [get, set]
 Gets or Sets Display More...
 
List< DocGenFormFieldDocGenFormFields [get, set]
 Gets or Sets DocGenFormFields More...
 
string DocumentBase64 [get, set]
 The document&#39;s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding. More...
 
List< NameValueDocumentFields [get, set]
 Gets or Sets DocumentFields More...
 
string DocumentId [get, set]
 Specifies the document ID number that the tab is placed on. This must refer to an existing Document&#39;s ID attribute. More...
 
string EncryptedWithKeyManager [get, set]
 When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. More...
 
string FileExtension [get, set]
 The file extension type of the document. If the document is not a PDF it is converted to a PDF. More...
 
string FileFormatHint [get, set]
 Gets or Sets FileFormatHint More...
 
DocumentHtmlDefinition HtmlDefinition [get, set]
 Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide. More...
 
string IncludeInDownload [get, set]
 Gets or Sets IncludeInDownload More...
 
string IsDocGenDocument [get, set]
 Gets or Sets IsDocGenDocument More...
 
List< MatchBoxMatchBoxes [get, set]
 Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. More...
 
string Name [get, set]
 Gets or Sets Name More...
 
string Order [get, set]
 Gets or Sets Order More...
 
string Pages [get, set]
 Gets or Sets Pages More...
 
string Password [get, set]
 Gets or Sets Password More...
 
string PdfFormFieldOption [get, set]
 Gets or Sets PdfFormFieldOption More...
 
string RemoteUrl [get, set]
 The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. More...
 
string SignerMustAcknowledge [get, set]
 Gets or Sets SignerMustAcknowledge More...
 
bool SignerMustAcknowledgeUseAccountDefault [get, set]
 Gets or Sets SignerMustAcknowledgeUseAccountDefault More...
 
Tabs Tabs [get, set]
 A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients. 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...
 
string TemplateRequired [get, set]
 When set to true, the sender may not remove the recipient. Used only when working with template recipients. More...
 
string TransformPdfFields [get, set]
 When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. More...
 
string Uri [get, set]
 Gets or Sets Uri More...
 

Detailed Description

A document object.

Constructor & Destructor Documentation

◆ Document()

DocuSign.eSign.Model.Document.Document ( string  ApplyAnchorTabs = default(string),
string  AssignTabsToRecipientId = default(string),
bool?  AuthoritativeCopy = default(bool?),
string  Display = default(string),
List< DocGenFormField DocGenFormFields = default(List<DocGenFormField>),
string  DocumentBase64 = default(string),
List< NameValue DocumentFields = default(List<NameValue>),
string  DocumentId = default(string),
string  EncryptedWithKeyManager = default(string),
string  FileExtension = default(string),
string  FileFormatHint = default(string),
DocumentHtmlDefinition  HtmlDefinition = default(DocumentHtmlDefinition),
string  IncludeInDownload = default(string),
string  IsDocGenDocument = default(string),
List< MatchBox MatchBoxes = default(List<MatchBox>),
string  Name = default(string),
string  Order = default(string),
string  Pages = default(string),
string  Password = default(string),
string  PdfFormFieldOption = default(string),
string  RemoteUrl = default(string),
string  SignerMustAcknowledge = default(string),
bool?  SignerMustAcknowledgeUseAccountDefault = default(bool?),
Tabs  Tabs = default(Tabs),
string  TemplateLocked = default(string),
string  TemplateRequired = default(string),
string  TransformPdfFields = default(string),
string  Uri = default(string) 
)
inline

Initializes a new instance of the Document class.

Parameters
ApplyAnchorTabsReserved: TBD.
AssignTabsToRecipientIdAssignTabsToRecipientId.
AuthoritativeCopySpecifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled..
DisplayDisplay.
DocGenFormFieldsDocGenFormFields.
DocumentBase64The document&#39;s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding..
DocumentFieldsDocumentFields.
DocumentIdSpecifies the document ID number that the tab is placed on. This must refer to an existing Document&#39;s ID attribute..
EncryptedWithKeyManagerWhen set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. .
FileExtensionThe file extension type of the document. If the document is not a PDF it is converted to a PDF. .
FileFormatHintFileFormatHint.
HtmlDefinitionDefines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide..
IncludeInDownloadIncludeInDownload.
IsDocGenDocumentIsDocGenDocument.
MatchBoxesMatchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox. .
NameName.
OrderOrder.
PagesPages.
PasswordPassword.
PdfFormFieldOptionPdfFormFieldOption.
RemoteUrlThe file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}]. .
SignerMustAcknowledgeSignerMustAcknowledge.
SignerMustAcknowledgeUseAccountDefaultSignerMustAcknowledgeUseAccountDefault.
TabsA list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients..
TemplateLockedWhen set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateRequiredWhen set to true, the sender may not remove the recipient. Used only when working with template recipients..
TransformPdfFieldsWhen set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs. .
UriUri.

Member Function Documentation

◆ Equals() [1/2]

override bool DocuSign.eSign.Model.Document.Equals ( object  obj)
inline

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

bool DocuSign.eSign.Model.Document.Equals ( Document  other)
inline

Returns true if Document instances are equal

Parameters
otherInstance of Document to be compared
Returns
Boolean

◆ GetHashCode()

override int DocuSign.eSign.Model.Document.GetHashCode ( )
inline

Gets the hash code

Returns
Hash code

◆ ToJson()

string DocuSign.eSign.Model.Document.ToJson ( )
inline

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

override string DocuSign.eSign.Model.Document.ToString ( )
inline

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ ApplyAnchorTabs

string DocuSign.eSign.Model.Document.ApplyAnchorTabs
getset

Reserved: TBD

Reserved: TBD

◆ AssignTabsToRecipientId

string DocuSign.eSign.Model.Document.AssignTabsToRecipientId
getset

Gets or Sets AssignTabsToRecipientId

◆ AuthoritativeCopy

bool DocuSign.eSign.Model.Document.AuthoritativeCopy
getset

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.

◆ Display

string DocuSign.eSign.Model.Document.Display
getset

Gets or Sets Display

◆ DocGenFormFields

List<DocGenFormField> DocuSign.eSign.Model.Document.DocGenFormFields
getset

Gets or Sets DocGenFormFields

◆ DocumentBase64

string DocuSign.eSign.Model.Document.DocumentBase64
getset

The document&#39;s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

The document&#39;s bytes. This field can be used to include a base64 version of the document bytes within an envelope definition instead of sending the document using a multi-part HTTP request. The maximum document size is smaller if this field is used due to the overhead of the base64 encoding.

◆ DocumentFields

List<NameValue> DocuSign.eSign.Model.Document.DocumentFields
getset

Gets or Sets DocumentFields

◆ DocumentId

string DocuSign.eSign.Model.Document.DocumentId
getset

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

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

◆ EncryptedWithKeyManager

string DocuSign.eSign.Model.Document.EncryptedWithKeyManager
getset

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance.

◆ FileExtension

string DocuSign.eSign.Model.Document.FileExtension
getset

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

The file extension type of the document. If the document is not a PDF it is converted to a PDF.

◆ FileFormatHint

string DocuSign.eSign.Model.Document.FileFormatHint
getset

Gets or Sets FileFormatHint

◆ HtmlDefinition

DocumentHtmlDefinition DocuSign.eSign.Model.Document.HtmlDefinition
getset

Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.

Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.

◆ IncludeInDownload

string DocuSign.eSign.Model.Document.IncludeInDownload
getset

Gets or Sets IncludeInDownload

◆ IsDocGenDocument

string DocuSign.eSign.Model.Document.IsDocGenDocument
getset

Gets or Sets IsDocGenDocument

◆ MatchBoxes

List<MatchBox> DocuSign.eSign.Model.Document.MatchBoxes
getset

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

Matchboxes define areas in a document for document matching when you are creating envelopes. They are only used when you upload and edit a template. A matchbox consists of 5 elements: * pageNumber - The document page number on which the matchbox will appear. * xPosition - The x position of the matchbox on a page. * yPosition - The y position of the matchbox on a page. * width - The width of the matchbox. * height - The height of the matchbox.

◆ Name

string DocuSign.eSign.Model.Document.Name
getset

Gets or Sets Name

◆ Order

string DocuSign.eSign.Model.Document.Order
getset

Gets or Sets Order

◆ Pages

string DocuSign.eSign.Model.Document.Pages
getset

Gets or Sets Pages

◆ Password

string DocuSign.eSign.Model.Document.Password
getset

Gets or Sets Password

◆ PdfFormFieldOption

string DocuSign.eSign.Model.Document.PdfFormFieldOption
getset

Gets or Sets PdfFormFieldOption

◆ RemoteUrl

string DocuSign.eSign.Model.Document.RemoteUrl
getset

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

The file id from the cloud storage service where the document is located. This information is returned using [ML:GET /folders] or [ML:/folders/{folderid}].

◆ SignerMustAcknowledge

string DocuSign.eSign.Model.Document.SignerMustAcknowledge
getset

Gets or Sets SignerMustAcknowledge

◆ SignerMustAcknowledgeUseAccountDefault

bool DocuSign.eSign.Model.Document.SignerMustAcknowledgeUseAccountDefault
getset

Gets or Sets SignerMustAcknowledgeUseAccountDefault

◆ Tabs

Tabs DocuSign.eSign.Model.Document.Tabs
getset

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

A list of tabs, which are represented graphically as symbols on documents at the time of signing. Tabs show recipients where to sign, initial, or enter data. They may also display data to the recipients.

◆ TemplateLocked

string DocuSign.eSign.Model.Document.TemplateLocked
getset

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.

◆ TemplateRequired

string DocuSign.eSign.Model.Document.TemplateRequired
getset

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

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

◆ TransformPdfFields

string DocuSign.eSign.Model.Document.TransformPdfFields
getset

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

When set to true, PDF form field data is transformed into document tab values when the PDF form field name matches the DocuSign custom tab tabLabel. The resulting PDF form data is also returned in the PDF meta data when requesting the document PDF. See the [ML:Transform PDF Fields] section for more information about how fields are transformed into DocuSign tabs.

◆ Uri

string DocuSign.eSign.Model.Document.Uri
getset

Gets or Sets Uri


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