DocuSign.eSign.Model.TextCustomField Class Reference

This object represents a free text custom field where envelope creators and senders can enter custom data. More...

Inheritance diagram for DocuSign.eSign.Model.TextCustomField:

Public Member Functions
	TextCustomField (string ConfigurationType=default(string), ErrorDetails ErrorDetails=default(ErrorDetails), string FieldId=default(string), string Name=default(string), string Required=default(string), string Show=default(string), string Value=default(string))
	Initializes a new instance of the TextCustomField 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 (TextCustomField other)
	Returns true if TextCustomField instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	ConfigurationType [get, set]
	If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce. More...
ErrorDetails	ErrorDetails [get, set]
	Array or errors. More...
string	FieldId [get, set]
	An ID used to specify a custom field. More...
string	Name [get, set]
	The name of the custom field. More...
string	Required [get, set]
	When set to true, the signer is required to fill out this tab More...
string	Show [get, set]
	A boolean indicating if the value should be displayed. More...
string	Value [get, set]
	The value of the custom field. More...

Detailed Description

This object represents a free text custom field where envelope creators and senders can enter custom data.

Constructor & Destructor Documentation

TextCustomField()

DocuSign.eSign.Model.TextCustomField.TextCustomField ( string  ConfigurationType = default(string), ErrorDetails  ErrorDetails = default(ErrorDetails), string  FieldId = default(string), string  Name = default(string), string  Required = default(string), string  Show = default(string), string  Value = default(string)  )

inline

Initializes a new instance of the TextCustomField class.

Parameters

ConfigurationType	If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce..
ErrorDetails	Array or errors..
FieldId	An ID used to specify a custom field..
Name	The name of the custom field..
Required	When set to true, the signer is required to fill out this tab.
Show	A boolean indicating if the value should be displayed..
Value	The value of the custom field..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if TextCustomField instances are equal

Parameters

other

Instance of TextCustomField to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

ConfigurationType

string DocuSign.eSign.Model.TextCustomField.ConfigurationType

getset

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

If merge field's are being used, specifies the type of the merge field. The only supported value is salesforce.

ErrorDetails

ErrorDetails DocuSign.eSign.Model.TextCustomField.ErrorDetails

getset

Array or errors.

Array or errors.

FieldId

string DocuSign.eSign.Model.TextCustomField.FieldId

getset

An ID used to specify a custom field.

An ID used to specify a custom field.

Name

string DocuSign.eSign.Model.TextCustomField.Name

getset

The name of the custom field.

The name of the custom field.

Required

string DocuSign.eSign.Model.TextCustomField.Required

getset

When set to true, the signer is required to fill out this tab

When set to true, the signer is required to fill out this tab

Show

string DocuSign.eSign.Model.TextCustomField.Show

getset

A boolean indicating if the value should be displayed.

A boolean indicating if the value should be displayed.

Value

string DocuSign.eSign.Model.TextCustomField.Value

getset

The value of the custom field.

The value of the custom field.

---

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

• sdk/src/DocuSign.eSign/Model/TextCustomField.cs