TX Text Control .NET Server

SubTextPartInfo Object

Object|Introduced in 26.0

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

PropertyDescription
highlightModeOptional. The highlight mode.
idOptional. The ID of the SubTextPart.
lengthOptional. The length of the SubTextPart.
nameThe name of the SubTextPart.
startOptional. The one-based starting position of the SubTextPart.