DSMFormula.h
1 #import <DocuSignSDK/DocuSignSDK.h>
2 
7 @interface DSMFormula : DSMTab
8 
9 /* When set to **true**, sets this as a payment tab. Can only be used with Text, Number, Formula, or List tabs. The value of the tab must be a number. [optional]
10  */
11 @property(nonatomic,assign) BOOL isPaymentAmount;
12 /* The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. \nMaximum Length: 2000 characters.\n\n*Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be: \n\n[Line1]+[Line2]+[Tax] [optional]
13  */
14 @property(nonatomic,strong) NSString* formula;
15 /* A regular expressionn used to validate input for the tab. [optional]
16  */
17 @property(nonatomic,strong) NSString* validationPattern;
18 /* The message displayed if the custom tab fails input validation (either custom of embedded). [optional]
19  */
20 @property(nonatomic,strong) NSString* validationMessage;
21 /* When set to **true**, this custom tab is shared. [optional]
22  */
23 @property(nonatomic,assign) BOOL shared;
24 /* Optional element for field markup. When set to **true**, the signer is required to initial when they modify a shared field. [optional]
25  */
26 @property(nonatomic,assign) BOOL requireInitialOnSharedChange;
27 /* When set to **true**, the sender must populate the tab before an envelope can be sent using the template. \n\nThis value tab can only be changed by modifying (PUT) the template. \n\nTabs with a `senderRequired` value of true cannot be deleted from an envelope. [optional]
28  */
29 @property(nonatomic,assign) BOOL senderRequired;
30 /* When set to **true** and shared is true, information must be entered in this field to complete the envelope. [optional]
31  */
32 @property(nonatomic,assign) BOOL requireAll;
33 
34 /* The initial value of the tab when it was sent to the recipient. [optional]
35  */
36 @property(nonatomic,strong) NSString* originalValue;
37 /* Width of the tab in pixels. [optional]
38  */
39 @property(nonatomic,strong) NSNumber* width;
40 /* When set to **true**, the signer is required to fill out this tab [optional]
41  */
42 @property(nonatomic,assign) BOOL required;
43 /* When set to **true**, the signer cannot change the data of the custom tab. [optional]
44  */
45 @property(nonatomic,assign) BOOL locked;
46 /* When set to **true**, the field appears normally while the recipient is adding or modifying the information in the field, but the data is not visible (the characters are hidden by asterisks) to any other signer or the sender.\n\nWhen an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.\n\nThis setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. [optional]
47  */
48 @property(nonatomic,assign) BOOL concealValueOnDocument;
49 /* When set to **true**, disables the auto sizing of single line text boxes in the signing screen when the signer enters data. If disabled users will only be able enter as much data as the text box can hold. By default this is false. This property only affects single line text boxes. [optional]
50  */
51 @property(nonatomic,assign) BOOL disableAutoSize;
52 /* An optional value that describes the maximum length of the property when the property is a string. [optional]
53  */
54 @property(nonatomic,strong) NSNumber* maxLength;
55 
56 /* The font to be used for the tab value. Supported Fonts: Arial, Arial, ArialNarrow, Calibri, CourierNew, Garamond, Georgia, Helvetica, LucidaConsole, Tahoma, TimesNewRoman, Trebuchet, Verdana, MSGothic, MSMincho, Default. [optional]
57  */
58 @property(nonatomic,strong) NSString* font;
59 /* When set to **true**, the information in the tab is bold. [optional]
60  */
61 @property(nonatomic,assign) BOOL bold;
62 /* When set to **true**, the information in the tab is italic. [optional]
63  */
64 @property(nonatomic,assign) BOOL italic;
65 /* When set to **true**, the information in the tab is underlined. [optional]
66  */
67 @property(nonatomic,assign) BOOL underline;
68 /* The font color used for the information in the tab.\n\nPossible values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. [optional]
69  */
70 @property(nonatomic,strong) NSString* fontColor;
71 /* The font size used for the information in the tab.\n\nPossible values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. [optional]
72  */
73 @property(nonatomic,strong) NSString* fontSize;
74 
75 /* This indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. [optional]
76  */
77 @property(nonatomic,strong) NSString* xPosition;
78 /* This indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. [optional]
79  */
80 @property(nonatomic,strong) NSString* yPosition;
81 
82 /* This indicates the number of decimal places tabs should round to. Currently We support 0 or two. [optional]
83  */
84 @property(nonatomic,strong) NSNumber* roundDecimalPlaces;
85 
86 
87 @end
Definition: DSMTab.h:10
BOOL shared
Definition: DSMFormula.h:23
NSString * originalValue
Definition: DSMFormula.h:36
NSString * xPosition
Definition: DSMFormula.h:77
NSNumber * maxLength
Definition: DSMFormula.h:54
BOOL italic
Definition: DSMFormula.h:64
NSString * font
Definition: DSMFormula.h:58
Definition: DSMFormula.h:7
BOOL disableAutoSize
Definition: DSMFormula.h:51
BOOL requireInitialOnSharedChange
Definition: DSMFormula.h:26
BOOL requireAll
Definition: DSMFormula.h:32
BOOL concealValueOnDocument
Definition: DSMFormula.h:48
NSString * fontSize
Definition: DSMFormula.h:73
BOOL senderRequired
Definition: DSMFormula.h:29
BOOL isPaymentAmount
Definition: DSMFormula.h:11
NSString * validationPattern
Definition: DSMFormula.h:17
NSNumber * width
Definition: DSMFormula.h:39
NSString * formula
Definition: DSMFormula.h:14
BOOL required
Definition: DSMFormula.h:42
NSString * fontColor
Definition: DSMFormula.h:70
NSNumber * roundDecimalPlaces
Definition: DSMFormula.h:84
BOOL bold
Definition: DSMFormula.h:61
NSString * yPosition
Definition: DSMFormula.h:80
BOOL underline
Definition: DSMFormula.h:67
NSString * validationMessage
Definition: DSMFormula.h:20
BOOL locked
Definition: DSMFormula.h:45