new module:model/RadioGroup()
- Source:
Constructs a new RadioGroup.
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.
Members
(inner) conditionalParentLabel :String
- Source:
For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility.
Type:
- String
(inner) conditionalParentLabelMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the conditionalParentLabel property is editable.
Type:
(inner) conditionalParentValue :String
- Source:
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.
Type:
- String
(inner) conditionalParentValueMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the conditionalParentValue property is editable.
Type:
(inner) documentId :String
- Source:
Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute.
Type:
- String
(inner) documentIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the documentId property is editable.
Type:
(inner) groupName :String
- Source:
The name of the group.
Type:
- String
(inner) groupNameMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the groupName property is editable.
Type:
(inner) originalValue :String
- Source:
The initial value of the tab when it was sent to the recipient.
Type:
- String
(inner) originalValueMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the originalValue property is editable.
Type:
(inner) radios :Array.<module:model/Radio>
- Source:
Specifies the locations and status for radio buttons that are grouped together.
Type:
- Array.<module:model/Radio>
(inner) recipientId :String
- Source:
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document.
Type:
- String
(inner) recipientIdGuid :String
- Source:
Type:
- String
(inner) recipientIdGuidMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the recipientIdGuid property is editable.
Type:
(inner) recipientIdMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the recipientId property is editable.
Type:
(inner) requireAll :String
- Source:
When set to true and shared is true, information must be entered in this field to complete the envelope.
Type:
- String
(inner) requireAllMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the requireAll property is editable.
Type:
(inner) requireInitialOnSharedChange :String
- Source:
Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field.
Type:
- String
(inner) requireInitialOnSharedChangeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the requireInitialOnSharedChange property is editable.
Type:
(inner) shared :String
- Source:
When set to true, this custom tab is shared.
Type:
- String
(inner) sharedMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the shared property is editable.
Type:
(inner) shareToRecipients :String
- Source:
Type:
- String
(inner) shareToRecipientsMetadata :module:model/PropertyMetadata
- Source:
Reserved for DocuSign.
Type:
(inner) tabType :String
- Source:
Type:
- String
(inner) tabTypeMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tabType property is editable.
Type:
(inner) templateLocked :String
- Source:
When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients.
Type:
- String
(inner) templateLockedMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the templateLocked property is editable.
Type:
(inner) templateRequired :String
- Source:
When set to true, the sender may not remove the recipient. Used only when working with template recipients.
Type:
- String
(inner) templateRequiredMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the templateRequired property is editable.
Type:
(inner) tooltip :String
- Source:
Type:
- String
(inner) tooltipMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the tooltip property is editable.
Type:
(inner) value :String
- Source:
Specifies the value of the tab.
Type:
- String
(inner) valueMetadata :module:model/PropertyMetadata
- Source:
Metadata that indicates whether the value property is editable.
Type:
Methods
(static) constructFromObject(data, obj) → {module:model/RadioGroup}
- Source:
Constructs a RadioGroup from a plain JavaScript object, optionally creating a new instance.
Copies all relevant properties from data to obj if supplied or a new instance if not.
Parameters:
| Name | Type | Description |
|---|---|---|
data |
Object | The plain JavaScript object bearing properties of interest. |
obj |
module:model/RadioGroup | Optional instance to populate. |
Returns:
The populated RadioGroup instance.