SubTextPartInfo Object
Description
Specifies the properties of a new SubTextPart added via the (deprecated) method TextPart.addSubTextPart.
Syntax
{
name: <string>,
[id: <number>],
[start: <number>],
[length: <number>],
[highlightMode: <HighlightMode>]
}Examples
The following example demonstrates SubTextPartInfo in a practical document-editing workflow. It specifies the properties of a new SubTextPart added via the (deprecated) method TextPart.addSubTextPart.
function inspectSubTextPartInfo(subTextPartInfo) {
console.log("name:", subTextPartInfo.name);
console.log("id:", subTextPartInfo.id);
console.log("start:", subTextPartInfo.start);
console.log("length:", subTextPartInfo.length);
}Members
Properties
| Property | Description |
|---|---|
| highlightMode | Optional. The highlight mode. |
| id | Optional. The ID of the SubTextPart. |
| length | Optional. The length of the SubTextPart. |
| name | The name of the SubTextPart. |
| start | Optional. The one-based starting position of the SubTextPart. |