AnnTextHiliteObject Object

Summary

Defines an annotation hilite text review object.

Syntax

JavaScript Syntax

function lt.Annotations.Core.AnnTextHiliteObject 
	extends lt.Annotations.Core.AnnTextReviewObject 
	implements IAnnObjectCloneable

TypeScript Syntax

class lt.Annotations.Core.AnnTextHiliteObject() 
	extends lt.Annotations.Core.AnnTextReviewObject 
	implements IAnnObjectCloneable

Remarks

AnnTextHiliteObject derives from AnnTextReviewObject and has a renderer that will fill each rectangle with the current Fill value. The constructor of this object will create a solid yellow brush and set it in Fill and sets the Opacity value to 0.5.

Text hilite is used by application such as Microsoft Word and Adobe Acrobat to mark part of the text in review mode. The LEADTOOLS Document Viewer uses text hilite for this purpose. It also stores any text notes added by the reviewer in the metadata of the AnnObject using the ContentMetadataKey key.

Programmatically, the boundaries and rectangles of the text hilite object can be controlled using the following properties:

Example

This example creates a text hilite object and adds it to the automation container.

JavaScript Example

example: function SiteLibrary_DefaultPage$example() 
{ 
   // assumes _automation is valid 
   var inch = 720.0; 
    
   // Add a text hilight object 
   var annObj = new lt.Annotations.Core.AnnTextHiliteObject(); 
    
   // Set the points for the hotspot 
   annObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   annObj.get_points().add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
    
   // Add the object to the automation container 
   this._automation.get_container().get_children().add(annObj); 
    
   // Select the object 
   this._automation.selectObject(annObj); 
}