This group tab is used to place radio buttons on a document. The `radios` property contains a list of `radio` objects associated with the group. Only one radio button can be selected in a group. More...

Inheritance diagram for DocuSign.eSign.Model.RadioGroup:

Public Member Functions
	RadioGroup (string ConditionalParentLabel=default(string), PropertyMetadata ConditionalParentLabelMetadata=default(PropertyMetadata), string ConditionalParentValue=default(string), PropertyMetadata ConditionalParentValueMetadata=default(PropertyMetadata), string DocumentId=default(string), PropertyMetadata DocumentIdMetadata=default(PropertyMetadata), string GroupName=default(string), PropertyMetadata GroupNameMetadata=default(PropertyMetadata), string OriginalValue=default(string), PropertyMetadata OriginalValueMetadata=default(PropertyMetadata), List< Radio > Radios=default(List< Radio >), string RecipientId=default(string), string RecipientIdGuid=default(string), PropertyMetadata RecipientIdGuidMetadata=default(PropertyMetadata), PropertyMetadata RecipientIdMetadata=default(PropertyMetadata), string RequireAll=default(string), PropertyMetadata RequireAllMetadata=default(PropertyMetadata), string RequireInitialOnSharedChange=default(string), PropertyMetadata RequireInitialOnSharedChangeMetadata=default(PropertyMetadata), string Shared=default(string), PropertyMetadata SharedMetadata=default(PropertyMetadata), string ShareToRecipients=default(string), PropertyMetadata ShareToRecipientsMetadata=default(PropertyMetadata), string TabType=default(string), PropertyMetadata TabTypeMetadata=default(PropertyMetadata), string TemplateLocked=default(string), PropertyMetadata TemplateLockedMetadata=default(PropertyMetadata), string TemplateRequired=default(string), PropertyMetadata TemplateRequiredMetadata=default(PropertyMetadata), string Tooltip=default(string), PropertyMetadata TooltipMetadata=default(PropertyMetadata), string Value=default(string), PropertyMetadata ValueMetadata=default(PropertyMetadata))
	Initializes a new instance of the RadioGroup 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 (RadioGroup other)
	Returns true if RadioGroup instances are equal More...

override int	GetHashCode ()
	Gets the hash code More...

IEnumerable< ValidationResult >	Validate (ValidationContext validationContext)

Properties
string	ConditionalParentLabel `[get, set]`
	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. More...

PropertyMetadata	ConditionalParentLabelMetadata `[get, set]`
	Metadata that indicates whether the `conditionalParentLabel` property is editable. More...

string	ConditionalParentValue `[get, set]`
	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. More...

PropertyMetadata	ConditionalParentValueMetadata `[get, set]`
	Metadata that indicates whether the `conditionalParentValue` property is editable. 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...

PropertyMetadata	DocumentIdMetadata `[get, set]`
	Metadata that indicates whether the `documentId` property is editable. More...

string	GroupName `[get, set]`
	The name of the group. More...

PropertyMetadata	GroupNameMetadata `[get, set]`
	Metadata that indicates whether the `groupName` property is editable. More...

string	OriginalValue `[get, set]`
	The initial value of the tab when it was sent to the recipient. More...

PropertyMetadata	OriginalValueMetadata `[get, set]`
	Metadata that indicates whether the `originalValue` property is editable. More...

List< Radio >	Radios `[get, set]`
	Specifies the locations and status for radio buttons that are grouped together. More...

string	RecipientId `[get, set]`
	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. More...

string	RecipientIdGuid `[get, set]`
	Gets or Sets RecipientIdGuid More...

PropertyMetadata	RecipientIdGuidMetadata `[get, set]`
	Metadata that indicates whether the `recipientIdGuid` property is editable. More...

PropertyMetadata	RecipientIdMetadata `[get, set]`
	Metadata that indicates whether the `recipientId` property is editable. More...

string	RequireAll `[get, set]`
	When set to true and shared is true, information must be entered in this field to complete the envelope. More...

PropertyMetadata	RequireAllMetadata `[get, set]`
	Metadata that indicates whether the `requireAll` property is editable. More...

string	RequireInitialOnSharedChange `[get, set]`
	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. More...

PropertyMetadata	RequireInitialOnSharedChangeMetadata `[get, set]`
	Metadata that indicates whether the `requireInitialOnSharedChange` property is editable. More...

string	Shared `[get, set]`
	When set to true, this custom tab is shared. More...

PropertyMetadata	SharedMetadata `[get, set]`
	Metadata that indicates whether the `shared` property is editable. More...

string	ShareToRecipients `[get, set]`
	Gets or Sets ShareToRecipients More...

PropertyMetadata	ShareToRecipientsMetadata `[get, set]`
	Reserved for DocuSign. More...

string	TabType `[get, set]`
	Gets or Sets TabType More...

PropertyMetadata	TabTypeMetadata `[get, set]`
	Metadata that indicates whether the `tabType` property is editable. 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...

PropertyMetadata	TemplateLockedMetadata `[get, set]`
	Metadata that indicates whether the `templateLocked` property is editable. More...

string	TemplateRequired `[get, set]`
	When set to true, the sender may not remove the recipient. Used only when working with template recipients. More...

PropertyMetadata	TemplateRequiredMetadata `[get, set]`
	Metadata that indicates whether the `templateRequired` property is editable. More...

string	Tooltip `[get, set]`
	Gets or Sets Tooltip More...

PropertyMetadata	TooltipMetadata `[get, set]`
	Metadata that indicates whether the `tooltip` property is editable. More...

string	Value `[get, set]`
	Specifies the value of the tab. More...

PropertyMetadata	ValueMetadata `[get, set]`
	Metadata that indicates whether the `value` property is editable. More...

Detailed Description

This group tab is used to place radio buttons on a document. The `radios` property contains a list of `radio` objects associated with the group. Only one radio button can be selected in a group.

Constructor & Destructor Documentation

◆ RadioGroup()

DocuSign.eSign.Model.RadioGroup.RadioGroup	(	string	ConditionalParentLabel = `default(string)`,
		PropertyMetadata	ConditionalParentLabelMetadata = `default(PropertyMetadata)`,
		string	ConditionalParentValue = `default(string)`,
		PropertyMetadata	ConditionalParentValueMetadata = `default(PropertyMetadata)`,
		string	DocumentId = `default(string)`,
		PropertyMetadata	DocumentIdMetadata = `default(PropertyMetadata)`,
		string	GroupName = `default(string)`,
		PropertyMetadata	GroupNameMetadata = `default(PropertyMetadata)`,
		string	OriginalValue = `default(string)`,
		PropertyMetadata	OriginalValueMetadata = `default(PropertyMetadata)`,
		List< Radio >	Radios = `default(List<Radio>)`,
		string	RecipientId = `default(string)`,
		string	RecipientIdGuid = `default(string)`,
		PropertyMetadata	RecipientIdGuidMetadata = `default(PropertyMetadata)`,
		PropertyMetadata	RecipientIdMetadata = `default(PropertyMetadata)`,
		string	RequireAll = `default(string)`,
		PropertyMetadata	RequireAllMetadata = `default(PropertyMetadata)`,
		string	RequireInitialOnSharedChange = `default(string)`,
		PropertyMetadata	RequireInitialOnSharedChangeMetadata = `default(PropertyMetadata)`,
		string	Shared = `default(string)`,
		PropertyMetadata	SharedMetadata = `default(PropertyMetadata)`,
		string	ShareToRecipients = `default(string)`,
		PropertyMetadata	ShareToRecipientsMetadata = `default(PropertyMetadata)`,
		string	TabType = `default(string)`,
		PropertyMetadata	TabTypeMetadata = `default(PropertyMetadata)`,
		string	TemplateLocked = `default(string)`,
		PropertyMetadata	TemplateLockedMetadata = `default(PropertyMetadata)`,
		string	TemplateRequired = `default(string)`,
		PropertyMetadata	TemplateRequiredMetadata = `default(PropertyMetadata)`,
		string	Tooltip = `default(string)`,
		PropertyMetadata	TooltipMetadata = `default(PropertyMetadata)`,
		string	Value = `default(string)`,
		PropertyMetadata	ValueMetadata = `default(PropertyMetadata)`
	)

inline

Initializes a new instance of the RadioGroup class.

Parameters

ConditionalParentLabel	For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility..
ConditionalParentLabelMetadata	Metadata that indicates whether the `conditionalParentLabel` property is editable..
ConditionalParentValue	For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active. .
ConditionalParentValueMetadata	Metadata that indicates whether the `conditionalParentValue` property is editable..
DocumentId	Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute..
DocumentIdMetadata	Metadata that indicates whether the `documentId` property is editable..
GroupName	The name of the group..
GroupNameMetadata	Metadata that indicates whether the `groupName` property is editable..
OriginalValue	The initial value of the tab when it was sent to the recipient. .
OriginalValueMetadata	Metadata that indicates whether the `originalValue` property is editable..
Radios	Specifies the locations and status for radio buttons that are grouped together..
RecipientId	Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document..
RecipientIdGuid	RecipientIdGuid.
RecipientIdGuidMetadata	Metadata that indicates whether the `recipientIdGuid` property is editable..
RecipientIdMetadata	Metadata that indicates whether the `recipientId` property is editable..
RequireAll	When set to true and shared is true, information must be entered in this field to complete the envelope. .
RequireAllMetadata	Metadata that indicates whether the `requireAll` property is editable..
RequireInitialOnSharedChange	Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field..
RequireInitialOnSharedChangeMetadata	Metadata that indicates whether the `requireInitialOnSharedChange` property is editable..
Shared	When set to true, this custom tab is shared..
SharedMetadata	Metadata that indicates whether the `shared` property is editable..
ShareToRecipients	ShareToRecipients.
ShareToRecipientsMetadata	Reserved for DocuSign..
TabType	TabType.
TabTypeMetadata	Metadata that indicates whether the `tabType` property is editable..
TemplateLocked	When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. .
TemplateLockedMetadata	Metadata that indicates whether the `templateLocked` property is editable..
TemplateRequired	When set to true, the sender may not remove the recipient. Used only when working with template recipients..
TemplateRequiredMetadata	Metadata that indicates whether the `templateRequired` property is editable..
Tooltip	Tooltip.
TooltipMetadata	Metadata that indicates whether the `tooltip` property is editable..
Value	Specifies the value of the tab. .
ValueMetadata	Metadata that indicates whether the `value` property is editable..

Member Function Documentation

◆ Equals() [1/2]

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

inline

Returns true if RadioGroup instances are equal

Parameters

other Instance of RadioGroup to be compared

Returns: Boolean

◆ GetHashCode()

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

inline

Gets the hash code

Returns: Hash code

◆ ToJson()

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

inline

Returns the JSON string presentation of the object

Returns: JSON string presentation of the object

◆ ToString()

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

inline

Returns the string presentation of the object

Returns: String presentation of the object

Property Documentation

◆ ConditionalParentLabel

string DocuSign.eSign.Model.RadioGroup.ConditionalParentLabel

getset

For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.

◆ ConditionalParentLabelMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.ConditionalParentLabelMetadata

getset

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

◆ ConditionalParentValue

string DocuSign.eSign.Model.RadioGroup.ConditionalParentValue

getset

For conditional fields, this is the value of the parent tab that controls the tab's visibility. If the parent tab is a Checkbox, Radio button, Optional Signature, or Optional Initial use "on" as the value to show that the parent tab is active.

◆ ConditionalParentValueMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.ConditionalParentValueMetadata

getset

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

◆ DocumentId

string DocuSign.eSign.Model.RadioGroup.DocumentId

getset

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

◆ DocumentIdMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.DocumentIdMetadata

getset

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

◆ GroupName

string DocuSign.eSign.Model.RadioGroup.GroupName

getset

The name of the group.

◆ GroupNameMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.GroupNameMetadata

getset

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

◆ OriginalValue

string DocuSign.eSign.Model.RadioGroup.OriginalValue

getset

The initial value of the tab when it was sent to the recipient.

◆ OriginalValueMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.OriginalValueMetadata

getset

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

◆ Radios

List<Radio> DocuSign.eSign.Model.RadioGroup.Radios

getset

Specifies the locations and status for radio buttons that are grouped together.

◆ RecipientId

string DocuSign.eSign.Model.RadioGroup.RecipientId

getset

Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.

◆ RecipientIdGuid

string DocuSign.eSign.Model.RadioGroup.RecipientIdGuid

getset

Gets or Sets RecipientIdGuid

◆ RecipientIdGuidMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.RecipientIdGuidMetadata

getset

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

◆ RecipientIdMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.RecipientIdMetadata

getset

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

◆ RequireAll

string DocuSign.eSign.Model.RadioGroup.RequireAll

getset

When set to true and shared is true, information must be entered in this field to complete the envelope.

◆ RequireAllMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.RequireAllMetadata

getset

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

◆ RequireInitialOnSharedChange

string DocuSign.eSign.Model.RadioGroup.RequireInitialOnSharedChange

getset

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.

◆ RequireInitialOnSharedChangeMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.RequireInitialOnSharedChangeMetadata

getset

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

◆ Shared

string DocuSign.eSign.Model.RadioGroup.Shared

getset

When set to true, this custom tab is shared.

◆ SharedMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.SharedMetadata

getset

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

◆ ShareToRecipients

string DocuSign.eSign.Model.RadioGroup.ShareToRecipients

getset

Gets or Sets ShareToRecipients

◆ ShareToRecipientsMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.ShareToRecipientsMetadata

getset

Reserved for DocuSign.

◆ TabType

string DocuSign.eSign.Model.RadioGroup.TabType

getset

Gets or Sets TabType

◆ TabTypeMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.TabTypeMetadata

getset

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

◆ TemplateLocked

string DocuSign.eSign.Model.RadioGroup.TemplateLocked

getset

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

◆ TemplateLockedMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.TemplateLockedMetadata

getset

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

◆ TemplateRequired

string DocuSign.eSign.Model.RadioGroup.TemplateRequired

getset

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

◆ TemplateRequiredMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.TemplateRequiredMetadata

getset

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

◆ Tooltip

string DocuSign.eSign.Model.RadioGroup.Tooltip

getset

Gets or Sets Tooltip

◆ TooltipMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.TooltipMetadata

getset

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

◆ Value

string DocuSign.eSign.Model.RadioGroup.Value

getset

Specifies the value of the tab.

◆ ValueMetadata

PropertyMetadata DocuSign.eSign.Model.RadioGroup.ValueMetadata

getset

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/RadioGroup.cs

Public Member Functions

Properties

Detailed Description

Constructor & Destructor Documentation

◆ RadioGroup()

Member Function Documentation

◆ Equals() [1/2]

◆ Equals() [2/2]

◆ GetHashCode()

◆ ToJson()

◆ ToString()

Property Documentation

◆ ConditionalParentLabel

◆ ConditionalParentLabelMetadata

◆ ConditionalParentValue

◆ ConditionalParentValueMetadata

◆ DocumentId

◆ DocumentIdMetadata

◆ GroupName

◆ GroupNameMetadata

◆ OriginalValue

◆ OriginalValueMetadata

◆ Radios

◆ RecipientId

◆ RecipientIdGuid

◆ RecipientIdGuidMetadata

◆ RecipientIdMetadata

◆ RequireAll

◆ RequireAllMetadata

◆ RequireInitialOnSharedChange

◆ RequireInitialOnSharedChangeMetadata

◆ Shared

◆ SharedMetadata

◆ ShareToRecipients

◆ ShareToRecipientsMetadata

◆ TabType

◆ TabTypeMetadata

◆ TemplateLocked

◆ TemplateLockedMetadata

◆ TemplateRequired

◆ TemplateRequiredMetadata

◆ Tooltip

◆ TooltipMetadata

◆ Value

◆ ValueMetadata