# CommentThread

## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**anchorAllowWhiteSpaceInCharacters** | **String** |  | [optional] 
**anchorAllowWhiteSpaceInCharactersMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorCaseSensitive** | **String** | This property controls how [anchor tabs][AnchorTabs] are placed. When **true**, the text string in a document must match the case of the `anchorString` property for an anchor tab to be created. The default value is **false**.  For example, when set to **true**, if the anchor string is `DocuSign`, then `DocuSign` will match but `Docusign`, `docusign`, `DoCuSiGn`, etc. will not match. When set to **false**, `DocuSign`, `Docusign`, `docusign`, `DoCuSiGn`, etc. will all match.  This functionality uses the following rules:  - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:    $~><|^+=    For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`  - Strings embedded in other strings are ignored during the matching process.  - In words that have dashes, the parts separated by dashes are treated as distinct words.    Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.  - Letters with accent marks are treated as distinct characters from their unaccented counterparts.  - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.    Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.  - Unlike punctuation, numbers are not ignored when finding anchor words.    Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).  **Note**: You can only specify the value of this property in POST requests.  [AnchorTabs]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#autoplace | [optional] 
**anchorCaseSensitiveMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorHorizontalAlignment** | **String** | This property controls how [anchor tabs][AnchorTabs] are aligned in relation to the anchor text. Possible values are :  - `left`: Aligns the left side of the tab with the beginning of the first character of the matching anchor word. This is the default value. - `right`: Aligns the tab’s left side with the last character of the matching anchor word.  **Note**: You can only specify the value of this property in POST requests.  [AnchorTabs]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#autoplace  | [optional] 
**anchorHorizontalAlignmentMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorIgnoreIfNotPresent** | **String** | When set to **true**, this tab is ignored if the `anchorString` is not found in the document. | [optional] 
**anchorIgnoreIfNotPresentMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorMatchWholeWord** | **String** | When set to **true**, the text string in a document must match the value of the `anchorString` property in its entirety for an [anchor tab][AnchorTab] to be created. The default value is **false**.  For example, when set to **true**, if the input is `man` then `man` will match but `manpower`, `fireman`, and `penmanship` will not. When set to **false**, if the input is `man` then `man`, `manpower`, `fireman`, and `penmanship` will all match.  This functionality uses the following rules:  - Unless punctuation is specified in the `anchorString`, this functionality ignores punctuation and the following characters:    $~><|^+=    For example, the `anchorString` `water` will match on the string `Fetch a pail of water.`  - Strings embedded in other strings are ignored during the matching process.  - In words that have dashes, the parts separated by dashes are treated as distinct words.    Example: If the anchor string is `forget`, then an anchor tab is placed on the `forget` in `forget-me-not`, even when `anchorMatchWholeWord` is set to **true**.  - Letters with accent marks are treated as distinct characters from their unaccented counterparts.  - For single-character anchor strings, if the two characters appear right next to each other in the document, a single anchor tab is placed for both of them.    Example: If the anchor string is `i`, then only one anchor tab is placed in `skiing`.  - Unlike punctuation, numbers are not ignored when finding anchor words.    Example: If the anchor string is `cat`, then `-cat-` is matched but `1cat2` is not when `anchorMatchWholeWord` is set to **true** (its default value).   **Note**: You can only specify the value of this property in POST requests.  [AnchorTab]: https://developers.docusign.com/esign-rest-api/guides/concepts/tabs#autoplace  | [optional] 
**anchorMatchWholeWordMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorString** | **String** | Specifies the string to find in the document and use as the basis for tab placement. | [optional] 
**anchorStringMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorTabProcessorVersion** | **String** | Reserved for DocuSign. | [optional] 
**anchorTabProcessorVersionMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorUnits** | **String** | Specifies units of the `anchorXOffset` and `anchorYOffset`. Valid units are:  - `pixels` - `inches` - `mms` - `cms`  | [optional] 
**anchorUnitsMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorXOffset** | **String** | Specifies the X axis location of the tab in `anchorUnits` relative to the `anchorString`.  | [optional] 
**anchorXOffsetMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**anchorYOffset** | **String** | Specifies the Y axis location of the tab in `anchorUnits` relative to the `anchorString`.  | [optional] 
**anchorYOffsetMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**bold** | **String** | When set to **true**, the information in the tab is bold. | [optional] 
**boldMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**comments** | [Comment] | An array of comment tabs that contain information about users' comments on documents. | [optional] 
**conditionalParentLabel** | **String** | For conditional fields this is the `tabLabel` of the parent tab that controls this tab's visibility. | [optional] 
**conditionalParentLabelMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**conditionalParentValue** | **String** | For conditional fields, this is the value of the parent tab that controls the tab's visibility.  If 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] 
**conditionalParentValueMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**customTabId** | **String** | 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] 
**customTabIdMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**documentId** | **String** | The `documentId` is set by the API client. It is an integer that falls between `1` and 2,147,483,647. The value is encoded as a string without commas. The values `1`, `2`, `3`, and so on are typically used to identify the first few documents in an envelope. Tab definitions include a `documentId` property that specifies the document on which to place the tab. | [optional] 
**documentIdMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**errorDetails** | [**ErrorDetails**](ErrorDetails.md) |  | [optional] 
**font** | **String** | The font to be used for the tab value. Supported fonts include:  - Default - Arial - ArialNarrow - Calibri - CourierNew - Garamond - Georgia - Helvetica - LucidaConsole - MSGothic - MSMincho - OCR-A - Tahoma - TimesNewRoman - Trebuchet - Verdana  | [optional] 
**fontColor** | **String** | The font color to use for the information in the tab. Possible values are:   - Black - BrightBlue - BrightRed - DarkGreen - DarkRed - Gold - Green - NavyBlue - Purple - White  | [optional] 
**fontColorMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**fontMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**fontSize** | **String** | The font size used for the information in the tab. Possible values are:  - Size7 - Size8 - Size9 - Size10 - Size11 - Size12 - Size14 - Size16 - Size18 - Size20 - Size22 - Size24 - Size26 - Size28 - Size36 - Size48 - Size72 | [optional] 
**fontSizeMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**formOrder** | **String** | An integer specifying the order in which the guided form HTML should render. The order is relative to the `formPageLabel`, the group by which to place the guided form HTML block. | [optional] 
**formOrderMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**formPageLabel** | **String** | A string specifying the group in which to place the guided form HTML. Each group displays as a separate guided forms page in the signing experience. | [optional] 
**formPageLabelMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**formPageNumber** | **String** | An integer specifying the order in which to present the guided form pages. | [optional] 
**formPageNumberMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**height** | **String** | The height of the tab in pixels. | [optional] 
**heightMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**italic** | **String** | When set to **true**, the information in the tab is italic. | [optional] 
**italicMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**localePolicy** | [**LocalePolicyTab**](LocalePolicyTab.md) |  | [optional] 
**mergeField** | [**MergeField**](MergeField.md) |  | [optional] 
**mergeFieldXml** | **String** |  | [optional] 
**pageNumber** | **String** | The page number being accessed. | [optional] 
**pageNumberMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**recipientId** | **String** | A local reference that senders use to map recipients to other objects, such as specific document tabs. Within an envelope, each `recipientId` must be unique, but there is no uniqueness requirement across envelopes. For example, many envelopes assign the first recipient a `recipientId` of `1`. | [optional] 
**recipientIdGuid** | **String** | The globally-unique identifier (GUID) for a specific recipient on a specific envelope. If the same recipient is associated with multiple envelopes, they will have a different GUID for each one. Read only. | [optional] 
**recipientIdGuidMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**recipientIdMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**smartContractInformation** | [**SmartContractInformation**](SmartContractInformation.md) |  | [optional] 
**status** | **String** | The status of the tab. Possible values are:  - `active`: The tab is active, but the recipient has not yet interacted with it. - `signed`: The recipient signed the tab. - `declined`: The recipient declined the envelope. - `na`: Used when the `status` property is not applicable to the tab type. (For example, a tab that has the `tabType` `SignerAttachmentOptional`). | [optional] 
**statusMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**tabGroupLabels** | **[String]** | An array of tab group labels that uniquely identify tab groups. To assign a tab to a `tabGroup`, you assign the `TabGroupLabel` to the `Tab.TabGroupLabels` array. | [optional] 
**tabGroupLabelsMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**tabId** | **String** | The unique identifier for the tab. | [optional] 
**tabIdMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**tabLabel** | **String** | The label associated with the tab. This value may be an empty string. If no value is provided, the tab type is used as the value.  Maximum Length: 500 characters.  | [optional] 
**tabLabelMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**tabOrder** | **String** | A positive integer that sets the order the tab is navigated to during signing.  Tabs on a page are navigated to in ascending order, starting with the lowest number and moving to the highest. If two or more tabs have the same `tabOrder` value, the normal auto-navigation setting behavior for the envelope is used. | [optional] 
**tabOrderMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**tabType** | **String** | Indicates the type of tab (for example, `signHere` or `initialHere`). | [optional] 
**tabTypeMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**templateLocked** | **String** | When set to **true**, the sender cannot change any attributes of the recipient. Used only when working with template recipients.  | [optional] 
**templateLockedMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**templateRequired** | **String** | When set to **true**, the sender may not remove the recipient. Used only when working with template recipients. | [optional] 
**templateRequiredMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**threadId** | **String** | The unique identifier for the comment thread. | [optional] 
**tooltip** | **String** | The text of a tooltip that appears when a user hovers over a form field or tab. | [optional] 
**toolTipMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**underline** | **String** | When set to **true**, the information in the tab is underlined. | [optional] 
**underlineMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**width** | **String** | The width of the tab in pixels. | [optional] 
**widthMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**xPosition** | **String** | This property indicates the horizontal offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.  | [optional] 
**xPositionMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 
**yPosition** | **String** | This property indicates the vertical offset of the object on the page. DocuSign uses 72 DPI when determining position. Required. May be zero.  | [optional] 
**yPositionMetadata** | [**PropertyMetadata**](PropertyMetadata.md) |  | [optional] 

[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)