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

Contains information for transfering values between Salesforce data fields and DocuSign Tabs. More...

Inheritance diagram for DocuSign.eSign.Model.MergeField:

Public Member Functions

 MergeField (string AllowSenderToEdit=default(string), PropertyMetadata AllowSenderToEditMetadata=default(PropertyMetadata), string ConfigurationType=default(string), PropertyMetadata ConfigurationTypeMetadata=default(PropertyMetadata), string Path=default(string), List< PathExtendedElement > PathExtended=default(List< PathExtendedElement >), PropertyMetadata PathExtendedMetadata=default(PropertyMetadata), PropertyMetadata PathMetadata=default(PropertyMetadata), string Row=default(string), PropertyMetadata RowMetadata=default(PropertyMetadata), string WriteBack=default(string), PropertyMetadata WriteBackMetadata=default(PropertyMetadata))
 Initializes a new instance of the MergeField 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 (MergeField other)
 Returns true if MergeField instances are equal More...
 
override int GetHashCode ()
 Gets the hash code More...
 
IEnumerable< ValidationResult > Validate (ValidationContext validationContext)
 

Properties

string AllowSenderToEdit [get, set]
 When set to true, the sender can modify the value of the custom tab during the sending process. More...
 
PropertyMetadata AllowSenderToEditMetadata [get, set]
 Metadata that indicates if the sender can edit the &#x60;allowSenderToEdit&#x60; property. More...
 
string ConfigurationType [get, set]
 If merge field&#39;s are being used, specifies the type of the merge field. The only supported value is salesforce. More...
 
PropertyMetadata ConfigurationTypeMetadata [get, set]
 Metadata that indicates if the sender can edit the &#x60;configurationType&#x60; property. More...
 
string Path [get, set]
 Sets the object associated with the custom tab. Currently this is the Salesforce Object. More...
 
List< PathExtendedElementPathExtended [get, set]
 Gets or Sets PathExtended More...
 
PropertyMetadata PathExtendedMetadata [get, set]
 Reserved for DocuSign. More...
 
PropertyMetadata PathMetadata [get, set]
 Metadata that indicates whether the &#x60;path&#x60; property is editable. More...
 
string Row [get, set]
 Specifies the row number in a Salesforce table that the merge field value corresponds to. More...
 
PropertyMetadata RowMetadata [get, set]
 Metadata that indicates whether the &#x60;row&#x60; property is editable. More...
 
string WriteBack [get, set]
 When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed. More...
 
PropertyMetadata WriteBackMetadata [get, set]
 Metadata that indicates if the sender can edit the &#x60;writeBack&#x60; property. More...
 

Detailed Description

Contains information for transfering values between Salesforce data fields and DocuSign Tabs.

Constructor & Destructor Documentation

◆ MergeField()

DocuSign.eSign.Model.MergeField.MergeField ( string  AllowSenderToEdit = default(string),
PropertyMetadata  AllowSenderToEditMetadata = default(PropertyMetadata),
string  ConfigurationType = default(string),
PropertyMetadata  ConfigurationTypeMetadata = default(PropertyMetadata),
string  Path = default(string),
List< PathExtendedElement PathExtended = default(List<PathExtendedElement>),
PropertyMetadata  PathExtendedMetadata = default(PropertyMetadata),
PropertyMetadata  PathMetadata = default(PropertyMetadata),
string  Row = default(string),
PropertyMetadata  RowMetadata = default(PropertyMetadata),
string  WriteBack = default(string),
PropertyMetadata  WriteBackMetadata = default(PropertyMetadata) 
)
inline

Initializes a new instance of the MergeField class.

Parameters
AllowSenderToEditWhen set to true, the sender can modify the value of the custom tab during the sending process..
AllowSenderToEditMetadataMetadata that indicates if the sender can edit the &#x60;allowSenderToEdit&#x60; property..
ConfigurationTypeIf merge field&#39;s are being used, specifies the type of the merge field. The only supported value is salesforce..
ConfigurationTypeMetadataMetadata that indicates if the sender can edit the &#x60;configurationType&#x60; property..
PathSets the object associated with the custom tab. Currently this is the Salesforce Object..
PathExtendedPathExtended.
PathExtendedMetadataReserved for DocuSign..
PathMetadataMetadata that indicates whether the &#x60;path&#x60; property is editable. .
RowSpecifies the row number in a Salesforce table that the merge field value corresponds to..
RowMetadataMetadata that indicates whether the &#x60;row&#x60; property is editable. .
WriteBackWhen wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed..
WriteBackMetadataMetadata that indicates if the sender can edit the &#x60;writeBack&#x60; property..

Member Function Documentation

◆ Equals() [1/2]

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

Returns true if objects are equal

Parameters
objObject to be compared
Returns
Boolean

◆ Equals() [2/2]

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

Returns true if MergeField instances are equal

Parameters
otherInstance of MergeField to be compared
Returns
Boolean

◆ GetHashCode()

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

Gets the hash code

Returns
Hash code

◆ ToJson()

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

Returns the JSON string presentation of the object

Returns
JSON string presentation of the object

◆ ToString()

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

Returns the string presentation of the object

Returns
String presentation of the object

Property Documentation

◆ AllowSenderToEdit

string DocuSign.eSign.Model.MergeField.AllowSenderToEdit
getset

When set to true, the sender can modify the value of the custom tab during the sending process.

When set to true, the sender can modify the value of the custom tab during the sending process.

◆ AllowSenderToEditMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.AllowSenderToEditMetadata
getset

Metadata that indicates if the sender can edit the &#x60;allowSenderToEdit&#x60; property.

Metadata that indicates if the sender can edit the &#x60;allowSenderToEdit&#x60; property.

◆ ConfigurationType

string DocuSign.eSign.Model.MergeField.ConfigurationType
getset

If merge field&#39;s are being used, specifies the type of the merge field. The only supported value is salesforce.

If merge field&#39;s are being used, specifies the type of the merge field. The only supported value is salesforce.

◆ ConfigurationTypeMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.ConfigurationTypeMetadata
getset

Metadata that indicates if the sender can edit the &#x60;configurationType&#x60; property.

Metadata that indicates if the sender can edit the &#x60;configurationType&#x60; property.

◆ Path

string DocuSign.eSign.Model.MergeField.Path
getset

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

Sets the object associated with the custom tab. Currently this is the Salesforce Object.

◆ PathExtended

List<PathExtendedElement> DocuSign.eSign.Model.MergeField.PathExtended
getset

Gets or Sets PathExtended

◆ PathExtendedMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.PathExtendedMetadata
getset

Reserved for DocuSign.

Reserved for DocuSign.

◆ PathMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.PathMetadata
getset

Metadata that indicates whether the &#x60;path&#x60; property is editable.

Metadata that indicates whether the &#x60;path&#x60; property is editable.

◆ Row

string DocuSign.eSign.Model.MergeField.Row
getset

Specifies the row number in a Salesforce table that the merge field value corresponds to.

Specifies the row number in a Salesforce table that the merge field value corresponds to.

◆ RowMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.RowMetadata
getset

Metadata that indicates whether the &#x60;row&#x60; property is editable.

Metadata that indicates whether the &#x60;row&#x60; property is editable.

◆ WriteBack

string DocuSign.eSign.Model.MergeField.WriteBack
getset

When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.

When wet to true, the information entered in the tab automatically updates the related Salesforce data when an envelope is completed.

◆ WriteBackMetadata

PropertyMetadata DocuSign.eSign.Model.MergeField.WriteBackMetadata
getset

Metadata that indicates if the sender can edit the &#x60;writeBack&#x60; property.

Metadata that indicates if the sender can edit the &#x60;writeBack&#x60; property.


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