DSMText Class Reference

#import <DSMText.h>

Inheritance diagram for DSMText:
DSMTab <DSMTextTabProtocol>

Properties

BOOL isPaymentAmount
 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]. More...
 
NSString * formula
 The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Length: 2000 characters.

*Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be:

[Line1]+[Line2]+[Tax] [optional]. More...
 
NSString * validationPattern
 A regular expressionn used to validate input for the tab. [optional]. More...
 
NSString * validationMessage
 The message displayed if the custom tab fails input validation (either custom of embedded). [optional]. More...
 
BOOL shared
 When set to true, this custom tab is shared. [optional]. More...
 
BOOL requireInitialOnSharedChange
 Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. [optional]. More...
 
BOOL senderRequired
 When set to true, the sender must populate the tab before an envelope can be sent using the template.
value tab can only be changed by modifying (PUT) the template.
with a senderRequired value of true cannot be deleted from an envelope. [optional]. More...
 
BOOL requireAll
 When set to true and shared is true, information must be entered in this field to complete the envelope. [optional]. More...
 
NSString * originalValue
 The initial value of the tab when it was sent to the recipient. [optional]. More...
 
BOOL locked
 When set to true, the signer cannot change the data of the custom tab. [optional]. More...
 
BOOL concealValueOnDocument
 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.
an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.
setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. [optional]. More...
 
BOOL disableAutoSize
 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]. More...
 
NSNumber * maxLength
 An optional value that describes the maximum length of the property when the property is a string. [optional]. More...
 
NSString * font
 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]. More...
 
BOOL bold
 When set to true, the information in the tab is bold. [optional]. More...
 
BOOL italic
 When set to true, the information in the tab is italic. [optional]. More...
 
BOOL underline
 When set to true, the information in the tab is underlined. [optional]. More...
 
NSString * fontColor
 The font color used for the information in the tab.
values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. [optional]. More...
 
NSString * fontSize
 The font size used for the information in the tab.
values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. [optional]. More...
 
- 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...
 
- Properties inherited from <DSMTextTabProtocol>
BOOL required
 When set to true, the signer is required to fill out this 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

It describes a Text tab capabilities. Specifies a that that is an adaptable field that allows the recipient to enter different text information.
getting information that includes this tab type, the original value of the tab when the associated envelope was sent is included in the response.

See also
DSMTextTabProtocol.h

Property Documentation

◆ bold

- (BOOL) bold
readwritenonatomicassign

When set to true, the information in the tab is bold. [optional].

◆ concealValueOnDocument

- (BOOL) concealValueOnDocument
readwritenonatomicassign

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.
an envelope is completed the information is available to the sender through the Form Data link in the DocuSign Console.
setting applies only to text boxes and does not affect list boxes, radio buttons, or check boxes. [optional].

◆ disableAutoSize

- (BOOL) disableAutoSize
readwritenonatomicassign

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].

◆ font

- (NSString*) font
readwritenonatomiccopy

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].

◆ fontColor

- (NSString*) fontColor
readwritenonatomiccopy

The font color used for the information in the tab.
values are: Black, BrightBlue, BrightRed, DarkGreen, DarkRed, Gold, Green, NavyBlue, Purple, or White. [optional].

◆ fontSize

- (NSString*) fontSize
readwritenonatomiccopy

The font size used for the information in the tab.
values are: Size7, Size8, Size9, Size10, Size11, Size12, Size14, Size16, Size18, Size20, Size22, Size24, Size26, Size28, Size36, Size48, or Size72. [optional].

◆ formula

- (NSString*) formula
readwritenonatomiccopy

The Formula string contains the TabLabel for the reference tabs used in the formula and calculation operators. Each TabLabel must be contained in brackets. Length: 2000 characters.

*Example*: Three tabs (TabLabels: Line1, Line2, and Tax) need to be added together. The formula string would be:

[Line1]+[Line2]+[Tax] [optional].

◆ isPaymentAmount

- (BOOL) isPaymentAmount
readwritenonatomicassign

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].

◆ italic

- (BOOL) italic
readwritenonatomicassign

When set to true, the information in the tab is italic. [optional].

◆ locked

- (BOOL) locked
readwritenonatomicassign

When set to true, the signer cannot change the data of the custom tab. [optional].

◆ maxLength

- (NSNumber*) maxLength
readwritenonatomiccopy

An optional value that describes the maximum length of the property when the property is a string. [optional].

◆ originalValue

- (NSString*) originalValue
readwritenonatomiccopy

The initial value of the tab when it was sent to the recipient. [optional].

◆ requireAll

- (BOOL) requireAll
readwritenonatomicassign

When set to true and shared is true, information must be entered in this field to complete the envelope. [optional].

◆ requireInitialOnSharedChange

- (BOOL) requireInitialOnSharedChange
readwritenonatomicassign

Optional element for field markup. When set to true, the signer is required to initial when they modify a shared field. [optional].

◆ senderRequired

- (BOOL) senderRequired
readwritenonatomicassign

When set to true, the sender must populate the tab before an envelope can be sent using the template.
value tab can only be changed by modifying (PUT) the template.
with a senderRequired value of true cannot be deleted from an envelope. [optional].

◆ shared

- (BOOL) shared
readwritenonatomicassign

When set to true, this custom tab is shared. [optional].

◆ underline

- (BOOL) underline
readwritenonatomicassign

When set to true, the information in the tab is underlined. [optional].

◆ validationMessage

- (NSString*) validationMessage
readwritenonatomiccopy

The message displayed if the custom tab fails input validation (either custom of embedded). [optional].

◆ validationPattern

- (NSString*) validationPattern
readwritenonatomiccopy

A regular expressionn used to validate input for the tab. [optional].


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