DSMTab.h
1 #import <Foundation/Foundation.h>
2 #import <CoreGraphics/CoreGraphics.h>
3 
5 
6 typedef NS_ENUM(NSUInteger, DSMTabType);
10 @interface DSMTab : NSObject
11 
16 @property(nonatomic) DSMTabType tabType;
18 @property (nonatomic, copy) NSString *documentId;
20 @property (nonatomic, copy) NSString *tabLabel;
22 @property (nonatomic, copy) NSNumber *pageNumber;
24 @property (nonatomic, copy) NSString *recipientId;
26 @property (nonatomic, copy) NSString *tabId;
28 @property (nonatomic, assign) BOOL templateLocked;
30 @property (nonatomic, assign) BOOL templateRequired;
32 @property (nonatomic, copy) NSNumber *tabOrder;
34 @property (nonatomic, copy) NSString *name;
36 @property (nonatomic, copy) NSString *customTabId;
38 @property (nonatomic, copy) NSString *anchorString;
40 @property (nonatomic, copy) NSNumber *anchorXOffset;
42 @property (nonatomic, copy) NSNumber *anchorYOffset;
44 @property (nonatomic, copy) NSString *anchorUnits;
46 @property (nonatomic, assign) BOOL anchorIgnoreIfNotPresent;
48 @property (nonatomic, assign) BOOL anchorCaseSensitive;
50 @property (nonatomic, assign) BOOL anchorMatchWholeWord;
52 @property (nonatomic, copy) NSString *anchorHorizontalAlignment;
54 @property (nonatomic, copy) NSString *conditionalParentLabel;
56 @property (nonatomic, copy) NSString *conditionalParentValue;
58 @property (nonatomic, copy) NSString *status;
59 
64 @property (nonatomic, retain) DSMTabFrame *frame;
69 @property (nonatomic, retain) DSMMergeField* mergeField;
74 @property (nonatomic, retain) DSMErrorDetails* errorDetails;
75 //@property (nonatomic, retain) DSMCDTabImageData *imageData;
76 
78 @property (nonatomic, copy) NSString *value;
79 
81 - (CGRect)frameAsCGRect;
83 - (void)setFrameWithCGRect:(CGRect)frame;
84 
85 @end
DSMErrorDetails * errorDetails
The DSMErrorDetails class object.
Definition: DSMTab.h:74
NSNumber * anchorYOffset
Specifies the Y axis location of the tab, in achorUnits, relative to the anchorString. [optional].
Definition: DSMTab.h:42
NSString * tabLabel
The label string associated with the tab. [optional].
Definition: DSMTab.h:20
DSMTabType tabType
The DSMTabType enum denoting tab type.
Definition: DSMTab.h:16
NSNumber * pageNumber
Specifies the page number on which the tab is located. [optional].
Definition: DSMTab.h:22
Definition: DSMTab.h:10
NSNumber * tabOrder
Order of tab.
Definition: DSMTab.h:32
NSString * anchorString
Anchor text information for a radio button. [optional].
Definition: DSMTab.h:38
NSString * value
Specifies the value of the tab. [optional].
Definition: DSMTab.h:78
NSString * conditionalParentValue
For conditional fields, this is the value of the parent tab that controls the tab&#39;s visibility...
Definition: DSMTab.h:56
DSMTabFrame * frame
The DSMTabFrame class object.
Definition: DSMTab.h:64
Definition: DSMErrorDetails.h:6
NSString * conditionalParentLabel
For conditional fields this is the TabLabel of the parent tab that controls this tab&#39;s visibility...
Definition: DSMTab.h:54
DSMMergeField * mergeField
The DSMMergeField class object.
Definition: DSMTab.h:69
Definition: DSMMergeField.h:6
NSString * anchorHorizontalAlignment
Determines if the anchor tabs horizontal alignment setting.
Definition: DSMTab.h:52
NSString * tabId
The unique identifier for the tab. The tabid can be retrieved with the [ML:GET call]. [optional].
Definition: DSMTab.h:26
NSString * anchorUnits
Specifies units of the X and Y offset. Units could be pixels, millimeters, centimeters, or inches. [optional].
Definition: DSMTab.h:44
NSString * status
Indicates the envelope status. Valid values are: * sent - The envelope is sent to the recipients...
Definition: DSMTab.h:58
NSString * name
Name of tab.
Definition: DSMTab.h:34
NSString * recipientId
Unique for the recipient. It is used by the tab element to indicate which recipient is to sign the Do...
Definition: DSMTab.h:24
NSString * documentId
Specifies the document ID number that the tab is placed on. This must refer to an existing Document&#39;s...
Definition: DSMTab.h:18
BOOL anchorIgnoreIfNotPresent
When set to true, this tab is ignored if anchorString is not found in the document. [optional].
Definition: DSMTab.h:46
BOOL templateRequired
When set to true, the sender may not remove the recipient. Used only when working with template recip...
Definition: DSMTab.h:30
CGRect frameAsCGRect()
Returns frame rectangle of the tab.
NSString * customTabId
The DocuSign generated custom tab ID for the custom tab to be applied. This can only be used when add...
Definition: DSMTab.h:36
BOOL templateLocked
When set to true, the sender cannot change any attributes of the recipient. Used only when working wi...
Definition: DSMTab.h:28
Definition: DSMTabFrame.h:6
BOOL anchorMatchWholeWord
Determines if the anchor text has to match whole word.
Definition: DSMTab.h:50
NSNumber * anchorXOffset
Specifies the X axis location of the tab, in achorUnits, relative to the anchorString. [optional].
Definition: DSMTab.h:40
BOOL anchorCaseSensitive
Determines if the anchor text is caseSensitive.
Definition: DSMTab.h:48