In This Topic ▼

selectedTextToReviewObject Method

Summary

Add the selected text items of page to a a text review object.

Syntax

TypeScript

JavaScript

DocumentViewerAnnotations.prototype.selectedTextToReviewObject = function( 
   pageNumber, 
   textReviewObject 
)

selectedTextToReviewObject( 
   pageNumber: number, 
   textReviewObject: AnnTextReviewObject 
): boolean;

pageNumber

1-based page number to use.

textReviewObject

Annotation text review object to use as the target for selected text items. This must not be null.

true if the method was successful and the selected text items where added to textReviewObject, otherwise; false.

Remarks

This method is called by the internal AnnTextReviewObject draw designer when the user creates a new text review object from the current selection.

This methods uses GetSelectedTextItems to get the rectangles of the selected text items and adds them to textReviewObject using SetRectangles.

If textReviewObject is not a child of the AnnContainer object associated with the page then it will be added to the Children collection. This operation will be wrapped by BeginUndo and endUndo will be selected by the automation using SelectObject.

Requirements

Help Version 20.0.2020.4.3