textMap Property (DocumentPageText)

Summary

List that contains the indices into Characters of each character in Text

Syntax

JavaScript Syntax

Object.defineProperty(DocumentPageText.prototype, 'textMap', 
	get: function() 
)

TypeScript Syntax

textMap: number[]; // read-only

Property Value

A list of integers that contain the indices into Characters of each character in Text. Default value is null.

Remarks

TextMap is populated by this object when BuildTextWithMap is called. It will contain the indices into Characters of each character in the string Text. This works similarly to BuildWords, in the example if HelloWorld, TextMap, Text will contain the string "Hello World" while TextMap will have 11 entries as follows:

0 1 2 3 4 -1 5 6 7 8 9 
H e l l o    W o r l d

In this example, TextMap contains 11 entries even through the length of Characters is 10. The extra entry is for the whitespace character inserted by BuildTextWithMap. This character will have an entry value of -1 since it is not part of the Characters list.

Requirements

Target Platforms

See Also