clipText Method (original) (raw)

Syntax

DocumentPageText.prototype.clipText = function( _bounds_ )

Parameters

bounds

The area to clone. This value is in document coordinates.

Return Value

New DocumentPageText.

Remarks

Use this method to create a copy of DocumentPageText that contains only the characters that intersect with a specified rectangle. For example, if your application contains functionality where the user can select a portion of the page using rubber band to extract text from, then you can use ClipText on the page object to return a new object that can be used with BuildWords orBuildText to parse only the words and text of the area.

ClipText works by checking the value of DocumentCharacter.Bounds of each item incharacters. If the value intersects, then it is added to the Characterslist of the new object.

If the value of bounds is empty (IsEmpty), then this method returns an exact copy of thisDocumentPageText.

bounds must be in document coordinates. Refer to Document Library Coordinate System for more information.