DSMFormula Class Reference

#import <DSMFormula.h>

Inheritance diagram for DSMFormula:
DSMTab

Properties

BOOL isPaymentAmount
 
NSString * formula
 
NSString * validationPattern
 
NSString * validationMessage
 
BOOL shared
 
BOOL requireInitialOnSharedChange
 
BOOL senderRequired
 
BOOL requireAll
 
NSString * originalValue
 
NSNumber * width
 
BOOL required
 
BOOL locked
 
BOOL concealValueOnDocument
 
BOOL disableAutoSize
 
NSNumber * maxLength
 
NSString * font
 
BOOL bold
 
BOOL italic
 
BOOL underline
 
NSString * fontColor
 
NSString * fontSize
 
NSString * xPosition
 
NSString * yPosition
 
NSNumber * roundDecimalPlaces
 
- Properties inherited from DSMTab
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...
 

Additional Inherited Members

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

Detailed Description

Various options to influence the template name matching.

Property Documentation

◆ bold

- (BOOL) bold
readwritenonatomicassign

◆ concealValueOnDocument

- (BOOL) concealValueOnDocument
readwritenonatomicassign

◆ disableAutoSize

- (BOOL) disableAutoSize
readwritenonatomicassign

◆ font

- (NSString*) font
readwritenonatomicstrong

◆ fontColor

- (NSString*) fontColor
readwritenonatomicstrong

◆ fontSize

- (NSString*) fontSize
readwritenonatomicstrong

◆ formula

- (NSString*) formula
readwritenonatomicstrong

◆ isPaymentAmount

- (BOOL) isPaymentAmount
readwritenonatomicassign

◆ italic

- (BOOL) italic
readwritenonatomicassign

◆ locked

- (BOOL) locked
readwritenonatomicassign

◆ maxLength

- (NSNumber*) maxLength
readwritenonatomicstrong

◆ originalValue

- (NSString*) originalValue
readwritenonatomicstrong

◆ requireAll

- (BOOL) requireAll
readwritenonatomicassign

◆ required

- (BOOL) required
readwritenonatomicassign

◆ requireInitialOnSharedChange

- (BOOL) requireInitialOnSharedChange
readwritenonatomicassign

◆ roundDecimalPlaces

- (NSNumber*) roundDecimalPlaces
readwritenonatomicstrong

◆ senderRequired

- (BOOL) senderRequired
readwritenonatomicassign

◆ shared

- (BOOL) shared
readwritenonatomicassign

◆ underline

- (BOOL) underline
readwritenonatomicassign

◆ validationMessage

- (NSString*) validationMessage
readwritenonatomicstrong

◆ validationPattern

- (NSString*) validationPattern
readwritenonatomicstrong

◆ width

- (NSNumber*) width
readwritenonatomicstrong

◆ xPosition

- (NSString*) xPosition
readwritenonatomicstrong

◆ yPosition

- (NSString*) yPosition
readwritenonatomicstrong

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