AnnTextObject Object

Summary

Provides support for creating and managing text annotation objects.

Syntax

JavaScript Syntax

function lt.Annotations.Core.AnnTextObject 
	extends lt.Annotations.Core.AnnRectangleObject 
	implements IAnnObjectCloneable

TypeScript Syntax

class lt.Annotations.Core.AnnTextObject() 
	extends lt.Annotations.Core.AnnRectangleObject 
	implements IAnnObjectCloneable

Remarks

The text annotation object is a text string within a bounding rectangle. This class supports a stroke and fill, that can be used on the bounding rectangle.

Programmatically, the boundaries and location of the text object can be controlled using the following properties: The AnnTextObject class inherits a number of properties from the AnnObject class, providing support for font, stroke and fill characteristics. These properties are listed below: The name of the text object can be controlled using Labels property, inherited from the AnnObject class. Each object can be transformed with the following methods: The following properties can also be used to programmatically set characteristics of an AnnTextObject:

Example

This example creates a text 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 object 
   var textObj = new lt.Annotations.Core.AnnTextObject(); 
    
   // Set the points for the hotspot 
   textObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   textObj.get_points().add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
   textObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   textObj.get_points().add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
   // Set the text 
   textObj.set_text("sample text for object\nsecond line of text\nlast line"); 
   // Add the object to the automation container 
   this._automation.get_container().get_children().add(textObj); 
   // Select the object 
   this._automation.selectObject(textObj); 
},