DocuSign.eSign.Model.ListItem Class Reference

One of the selectable items in the `listItems` property of a `list` tab. More...

Inheritance diagram for DocuSign.eSign.Model.ListItem:

Public Member Functions
	ListItem (string Selected=default(string), PropertyMetadata SelectedMetadata=default(PropertyMetadata), string Text=default(string), PropertyMetadata TextMetadata=default(PropertyMetadata), string Value=default(string), PropertyMetadata ValueMetadata=default(PropertyMetadata))
	Initializes a new instance of the ListItem 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 (ListItem other)
	Returns true if ListItem instances are equal More...
override int	GetHashCode ()
	Gets the hash code More...
IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	Selected [get, set]
	When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default. More...
PropertyMetadata	SelectedMetadata [get, set]
	Metadata that indicates whether the `selected` property is editable. More...
string	Text [get, set]
	Specifies the text that is shown in the dropdown list. More...
PropertyMetadata	TextMetadata [get, set]
	Gets or Sets TextMetadata More...
string	Value [get, set]
	Specifies the value that is used when the list item is selected. More...
PropertyMetadata	ValueMetadata [get, set]
	Metadata that indicates whether the `value` property is editable. More...

Detailed Description

One of the selectable items in the `listItems` property of a `list` tab.

Constructor & Destructor Documentation

ListItem()

DocuSign.eSign.Model.ListItem.ListItem ( string  Selected = default(string), PropertyMetadata  SelectedMetadata = default(PropertyMetadata), string  Text = default(string), PropertyMetadata  TextMetadata = default(PropertyMetadata), string  Value = default(string), PropertyMetadata  ValueMetadata = default(PropertyMetadata)  )

inline

Initializes a new instance of the ListItem class.

Parameters

Selected	When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default..
SelectedMetadata	Metadata that indicates whether the `selected` property is editable..
Text	Specifies the text that is shown in the dropdown list. .
TextMetadata	TextMetadata.
Value	Specifies the value that is used when the list item is selected..
ValueMetadata	Metadata that indicates whether the `value` property is editable..

Member Function Documentation

Equals() [1/2]

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

inline

Returns true if ListItem instances are equal

Parameters

other

Instance of ListItem to be compared

Returns

Boolean

GetHashCode()

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

inline

Gets the hash code

Returns

Hash code

ToJson()

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

inline

Returns the JSON string presentation of the object

Returns

JSON string presentation of the object

ToString()

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

inline

Returns the string presentation of the object

Returns

String presentation of the object

Property Documentation

Selected

string DocuSign.eSign.Model.ListItem.Selected

getset

When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.

When set to true, indicates that this item is the default selection shown to a signer. Only one selection can be set as the default.

SelectedMetadata

PropertyMetadata DocuSign.eSign.Model.ListItem.SelectedMetadata

getset

Metadata that indicates whether the `selected` property is editable.

Metadata that indicates whether the `selected` property is editable.

Text

string DocuSign.eSign.Model.ListItem.Text

getset

Specifies the text that is shown in the dropdown list.

Specifies the text that is shown in the dropdown list.

TextMetadata

PropertyMetadata DocuSign.eSign.Model.ListItem.TextMetadata

getset

Gets or Sets TextMetadata

Value

string DocuSign.eSign.Model.ListItem.Value

getset

Specifies the value that is used when the list item is selected.

Specifies the value that is used when the list item is selected.

ValueMetadata

PropertyMetadata DocuSign.eSign.Model.ListItem.ValueMetadata

getset

Metadata that indicates whether the `value` property is editable.

Metadata that indicates whether the `value` property is editable.

---

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

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