Skip to content

Latest commit

 

History

History
36 lines (32 loc) · 4.23 KB

RadioGroup.md

File metadata and controls

36 lines (32 loc) · 4.23 KB
Raw

RadioGroup

Properties

Name Type Description Notes
conditionalParentLabel String For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. [optional]
conditionalParentLabelMetadata PropertyMetadata [optional]
conditionalParentValue String 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. [optional]
conditionalParentValueMetadata PropertyMetadata [optional]
documentId String The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab. [optional]
documentIdMetadata PropertyMetadata [optional]
groupName String The name of the group. The search_text provided in the call automatically performs a wild card search on group_name. [optional]
groupNameMetadata PropertyMetadata [optional]
radios [Radio] Specifies the locations and status for radio buttons that are grouped together. [optional]
recipientId String A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. [optional]
recipientIdGuid String The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. [optional]
recipientIdGuidMetadata PropertyMetadata [optional]
recipientIdMetadata PropertyMetadata [optional]
requireAll String When set to true and shared is true, information must be entered in this field to complete the envelope. [optional]
requireAllMetadata PropertyMetadata [optional]
requireInitialOnSharedChange String Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. [optional]
requireInitialOnSharedChangeMetadata PropertyMetadata [optional]
shared String When set to true, this custom tab is shared. [optional]
sharedMetadata PropertyMetadata [optional]
tabType String Indicates the type of tab (for example, `signHere` or `initialHere`). [optional]
tabTypeMetadata PropertyMetadata [optional]
templateLocked String When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. [optional]
templateLockedMetadata PropertyMetadata [optional]
templateRequired String When set to true, the sender may not remove the recipient. Used only when working with template recipients. [optional]
templateRequiredMetadata PropertyMetadata [optional]
tooltip String The text of a tooltip that appears when a user hovers over a form field or tab. [optional]
tooltipMetadata PropertyMetadata [optional]

[Back to Model list] [Back to API list] [Back to README]