AnnNoteObject Object

The AnnNoteObject is a rectangle with a shadow border and brush background (yellow by default). It contains a text string with font properties. The text will wrap on word breaks within the object's specified rectangle.

With the automated functions, the user clicks or taps and drags to specify the rectangle in the current window. A dialog box then lets the user enter the text.

Programmatically, the boundaries and location of the note 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 AnnNoteObject 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 AnnNoteObject inherits a number of text properties from the AnnTextObject class that provide support for text alignment, margins, etc. These properties are listed below:

• AnnTextObject.Text
• AnnTextObject.TextRotate
• AnnTextObject.HorizontalAlignment
• AnnTextObject.VerticalAlignment
• AnnTextObject.TextBackground
• AnnTextObject.TextForeground
• AnnTextObject.Padding

The name of the note 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 AnnNoteObject:

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

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

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