DSMTab Class Reference

#import <DSMTab.h>

Inheritance diagram for DSMTab:
DSMCheckbox DSMCompany DSMDateSigned DSMFormula DSMFullName DSMInitialHere DSMSignHere DSMText DSMTitle

Instance Methods

(CGRect) - frameAsCGRect
 Returns frame rectangle of the tab. More...
 
(void) - setFrameWithCGRect:
 Set rect to be used as the frame for tab. More...
 

Properties

DSMTabType tabType
 The DSMTabType enum denoting tab type. More...
 
NSString * documentId
 Specifies the document ID number that the tab is placed on. This must refer to an existing Document's ID attribute. [optional]. More...
 
NSString * tabLabel
 The label string associated with the tab. [optional]. More...
 
NSNumber * pageNumber
 Specifies the page number on which the tab is located. [optional]. More...
 
NSString * recipientId
 Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Document. [optional]. More...
 
NSString * tabId
 The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. [optional]. More...
 
BOOL templateLocked
 When set to true, the sender cannot change any attributes of the recipient. Used only when working with template recipients. [optional]. More...
 
BOOL templateRequired
 When set to true, the sender may not remove the recipient. Used only when working with template recipients. [optional]. More...
 
NSNumber * tabOrder
 Order of tab. More...
 
NSString * name
 Name of tab. More...
 
NSString * customTabId
 The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. [optional]. More...
 
NSString * anchorString
 Anchor text information for a radio button. [optional]. More...
 
NSNumber * anchorXOffset
 Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. [optional]. More...
 
NSNumber * anchorYOffset
 Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. [optional]. More...
 
NSString * anchorUnits
 Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. [optional]. More...
 
BOOL anchorIgnoreIfNotPresent
 When set to true, this tab is ignored if anchorString is not found in the document. [optional]. More...
 
BOOL anchorCaseSensitive
 Determines if the anchor text is caseSensitive. More...
 
BOOL anchorMatchWholeWord
 Determines if the anchor text has to match whole word. More...
 
NSString * anchorHorizontalAlignment
 Determines if the anchor tabs horizontal alignment setting. More...
 
NSString * conditionalParentLabel
 For conditional fields this is the TabLabel of the parent tab that controls this tab's visibility. [optional]. More...
 
NSString * conditionalParentValue
 For conditional fields, this is the value of the parent tab that controls the tab's visibility.
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]. More...
 
NSString * status
 Indicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later. [optional]. More...
 
DSMTabFrameframe
 The DSMTabFrame class object. More...
 
DSMMergeFieldmergeField
 The DSMMergeField class object. More...
 
DSMErrorDetailserrorDetails
 The DSMErrorDetails class object. More...
 
NSString * value
 Specifies the value of the tab. [optional]. More...
 

Method Documentation

◆ frameAsCGRect()

- (CGRect) frameAsCGRect

Returns frame rectangle of the tab.

◆ setFrameWithCGRect:()

- (void) setFrameWithCGRect: (CGRect)  frame

Set rect to be used as the frame for tab.

Property Documentation

◆ anchorCaseSensitive

- (BOOL) anchorCaseSensitive
readwritenonatomicassign

Determines if the anchor text is caseSensitive.

◆ anchorHorizontalAlignment

- (NSString*) anchorHorizontalAlignment
readwritenonatomiccopy

Determines if the anchor tabs horizontal alignment setting.

◆ anchorIgnoreIfNotPresent

- (BOOL) anchorIgnoreIfNotPresent
readwritenonatomicassign

When set to true, this tab is ignored if anchorString is not found in the document. [optional].

◆ anchorMatchWholeWord

- (BOOL) anchorMatchWholeWord
readwritenonatomicassign

Determines if the anchor text has to match whole word.

◆ anchorString

- (NSString*) anchorString
readwritenonatomiccopy

Anchor text information for a radio button. [optional].

◆ anchorUnits

- (NSString*) anchorUnits
readwritenonatomiccopy

Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. [optional].

◆ anchorXOffset

- (NSNumber*) anchorXOffset
readwritenonatomiccopy

Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. [optional].

◆ anchorYOffset

- (NSNumber*) anchorYOffset
readwritenonatomiccopy

Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. [optional].

◆ conditionalParentLabel

- (NSString*) conditionalParentLabel
readwritenonatomiccopy

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

◆ conditionalParentValue

- (NSString*) conditionalParentValue
readwritenonatomiccopy

For conditional fields, this is the value of the parent tab that controls the tab's visibility.
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].

◆ customTabId

- (NSString*) customTabId
readwritenonatomiccopy

The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when adding new tabs for a recipient. When used, the new tab inherits all the custom tab properties. [optional].

◆ documentId

- (NSString*) documentId
readwritenonatomiccopy

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

◆ errorDetails

- (DSMErrorDetails*) errorDetails
readwritenonatomicretain

The DSMErrorDetails class object.

See also
DSMErrorDetails.h

◆ frame

- (DSMTabFrame*) frame
readwritenonatomicretain

The DSMTabFrame class object.

See also
DSMTabFrame.h

◆ mergeField

- (DSMMergeField*) mergeField
readwritenonatomicretain

The DSMMergeField class object.

See also
DSMMergeField.h

◆ name

- (NSString*) name
readwritenonatomiccopy

Name of tab.

◆ pageNumber

- (NSNumber*) pageNumber
readwritenonatomiccopy

Specifies the page number on which the tab is located. [optional].

◆ recipientId

- (NSString*) recipientId
readwritenonatomiccopy

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

◆ status

- (NSString*) status
readwritenonatomiccopy

Indicates the envelope status. Valid values are:

* sent - The envelope is sent to the recipients.
* created - The envelope is saved as a draft and can be modified and sent later. [optional].

◆ tabId

- (NSString*) tabId
readwritenonatomiccopy

The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. [optional].

◆ tabLabel

- (NSString*) tabLabel
readwritenonatomiccopy

The label string associated with the tab. [optional].

◆ tabOrder

- (NSNumber*) tabOrder
readwritenonatomiccopy

Order of tab.

◆ tabType

- (DSMTabType) tabType
readwritenonatomicassign

The DSMTabType enum denoting tab type.

See also
DSMTabType.h

◆ templateLocked

- (BOOL) templateLocked
readwritenonatomicassign

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

◆ templateRequired

- (BOOL) templateRequired
readwritenonatomicassign

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

◆ value

- (NSString*) value
readwritenonatomiccopy

Specifies the value of the tab. [optional].


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