AnnHiliteObject Object

The hilite annotation object is a simple rectangle that has a bounding rectangle, no pen and no brush. Although it does not have a pen or brush, it does have a color value that is used to fill this bounding area. By default the hilite object's fill color is yellow.

With the automated functions, the user clicks / taps and drags to specify the rectangle in the current window.

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

• AnnObject.Bounds
• AnnObject.Points

Each object can be transformed with the following methods:

• AnnObject.Scale
• AnnObject.Translate
• AnnObject.Rotate

The AnnHiliteObject class inherits a number of properties from the AnnObject class, providing support for font, stroke and fill characteristics. These properties are listed below:

• AnnObject.Fill
• AnnObject.Stroke
• AnnObject.Font
• AnnObject.SupportsFill
• AnnObject.SupportsStroke
• AnnObject.SupportsFont

The name of the hilite object can be controlled using AnnObject.Labels property, inherited from the AnnObject class.

An object can be part of a group annotation object or part of a container object. It cannot be part of both a group and a container at the same time.

The following properties can also be used to programmatically set characteristics of an AnnHiliteObject:

• AnnObject.Hyperlink
• AnnObject.IsLocked
• AnnObject.Password
• AnnObject.IsVisible

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

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