In This Topic ▼

buildText Method

Summary

Build the text found in the document page as a simple string object.

Syntax

TypeScript

JavaScript

DocumentPageText.prototype.buildText = function()

buildText(): void;

Remarks

The document page text can be obtained as a simple string object through the Text property. This is not performed automatically and you must call BuildText to populate this property with the text value from Characters. Note that BuildText will also build the words by calls BuildWords first if this has not been done by the user first.

After the words are set in BuildWords, this method will create the text string by appending all the items in Words separated by a white space character. The result is then set in Text.

Lines are separated by the by line feed characters (\n or LF, ASCII code 10) which is compatible with most text editors. If Windows style line-feed formats are desired to view the result in Windows only editors, such as Notepad, then use the following code snippet:

// Build the text normally 
pageText.buildText(); 
// Get the text 
var text = pageText.text; 
// Convert the lines to use Windows style \r\n line-feed 
text = text.replace("\n", "\r\n");

For more information, refer to Parsing Text with the Document Library.

Example

For an example, refer to GetText.

Requirements

Target Platforms