Docusign CSharp Docs
|
A document object. More...
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< DocGenFormField > | DocGenFormFields [get, set] |
Gets or Sets DocGenFormFields More... | |
string | DocumentBase64 [get, set] |
The document'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< NameValue > | DocumentFields [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'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< MatchBox > | MatchBoxes [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... | |
A document object.
|
inline |
Initializes a new instance of the Document class.
ApplyAnchorTabs | Reserved: TBD. |
AssignTabsToRecipientId | AssignTabsToRecipientId. |
AuthoritativeCopy | Specifies the Authoritative copy feature. If set to true the Authoritative copy feature is enabled.. |
Display | Display. |
DocGenFormFields | DocGenFormFields. |
DocumentBase64 | The document'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 | DocumentFields. |
DocumentId | Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.. |
EncryptedWithKeyManager | When set to true, the document is been already encrypted by the sender for use with the DocuSign Key Manager Security Appliance. . |
FileExtension | The file extension type of the document. If the document is not a PDF it is converted to a PDF. . |
FileFormatHint | FileFormatHint. |
HtmlDefinition | Defines how to generate the responsive-formatted HTML for the document. See Responsive signing in the eSignature concepts guide.. |
IncludeInDownload | IncludeInDownload. |
IsDocGenDocument | IsDocGenDocument. |
MatchBoxes | 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 | Name. |
Order | Order. |
Pages | Pages. |
Password | Password. |
PdfFormFieldOption | PdfFormFieldOption. |
RemoteUrl | 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 | SignerMustAcknowledge. |
SignerMustAcknowledgeUseAccountDefault | SignerMustAcknowledgeUseAccountDefault. |
Tabs | 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 | When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. . |
TemplateRequired | When set to true, the sender may not remove the recipient. Used only when working with template recipients.. |
TransformPdfFields | 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 | Uri. |
|
inline |
Returns true if objects are equal
obj | Object to be compared |
|
inline |
|
inline |
Gets the hash code
|
inline |
Returns the JSON string presentation of the object
|
inline |
Returns the string presentation of the object
|
getset |
Reserved: TBD
Reserved: TBD
|
getset |
Gets or Sets AssignTabsToRecipientId
|
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.
|
getset |
Gets or Sets Display
|
getset |
Gets or Sets DocGenFormFields
|
getset |
The document'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'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.
|
getset |
|
getset |
|
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.
|
getset |
Gets or Sets FileFormatHint
|
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.
|
getset |
Gets or Sets IncludeInDownload
|
getset |
Gets or Sets IsDocGenDocument
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.
|
getset |
Gets or Sets Name
|
getset |
Gets or Sets Order
|
getset |
Gets or Sets Pages
|
getset |
Gets or Sets Password
|
getset |
Gets or Sets PdfFormFieldOption
|
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}].
|
getset |
Gets or Sets SignerMustAcknowledge
|
getset |
Gets or Sets SignerMustAcknowledgeUseAccountDefault
|
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.
|
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.
|
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.
|
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.
|
getset |
Gets or Sets Uri