The TabStatus element contains information on tabs in the document.
Schema
| Name | Schema Type | Description |
|---|---|---|
| TabType | TabTypeCode | Returns the tab type. This element is enumerator controlled and can have following values; InitialHere, SignHere, FullName, Company, Title, DateSigned, InitialHereOptional, EnvelopeID, Custom, SignerAttachment, SignHereOptional, Approve, or Decline. Note that FirstName, LastName, EmailAddress, and SignerAttachmentOptional tab types are not returned in this SOAP version. |
| Status | String | The status of individual tabs. It can have the enumeration values; Active, Signed, Declined and N/A |
| XPosition/YPosition | Double | X position and Y position of the field. The X and Y positions originate at the upper left of the page and indicate the bottom left-most point of the field. For text fields, this is the upper left of the first letter of the text string. For signature fields, this is the upper left of the first letter of the signature stamp and does NOT include signature stamp image decoration which can surround the signature text. |
| Signed | dateTime | Note: The Signed information is not returned in the response, even though it is included in the SOAP WSDL.Date and time when the document was signed by the recipient. |
| TabLabel | String | This would be the label of the custom tab. |
| TabName | String | This would be the name of the custom tab. |
| TabValue | String | This element contains the value of the custom tab. |
| DocumentID | PositiveInteger | Only returned when calling RequestStatusEx and RequestStatusesEx. Returns the originating document ID. |
| PageNumber | PositiveInteger | Only returned when calling RequestStatusEx and RequestStatusesEx. Returns the page number the tab is on. |
| OriginalValue | String | Only returned when calling RequestStatusEx and RequestStatusesEx. Original value before signing. |
| ValidationPattern | String | Only returned when calling RequestStatusEx and RequestStatusesEx. Validation pattern that was originally passed in, if any. |
| RoleName | String | Only returned when calling RequestStatusEx and RequestStatusesEx. Only returned when the envelope originated from CreateEnvelopeFromTemplates. RoleName that this tab is associated with in the originating template. |
| ListValues | String | Only returned when calling RequestStatusEx and RequestStatusesEx. Returns the list values passed in when the envelope was created. |
| ListSelectedValue | String | Only returned when calling RequestStatusEx and RequestStatusesEx. Returns the selected value from ListValues. |
| ScaleValue | Decimal | Represents a decimal value of 0.0 to 1.0 position of the webcontrol scaling slider. A value of 1.0 represents full size. |
| CustomTabType | CustomTabType | Returns the custom tab type. |