AnnFreehandHotspotObject Object

Summary

Defines an annotation freehand hot spot object.

Syntax

JavaScript Syntax

function lt.Annotations.Core.AnnFreehandHotspotObject 
	extends lt.Annotations.Core.AnnPolylineObject 
	implements IAnnObjectCloneable

TypeScript Syntax

class lt.Annotations.Core.AnnFreehandHotspotObject() 
	extends lt.Annotations.Core.AnnPolylineObject 
	implements IAnnObjectCloneable

Remarks

The freehand hot spot annotation object is designed to work as a scaled picture drawn inside a collection of points that create a sequence of joined lines. The freehand hot spot object will draw the picture if the owner container is in design mode. If the container is in run mode, the freehand hot spot object will not draw the picture.

In run mode, the object is transparent, but the mouse pointer changes to a hand when it is over the object. You can change the points of a freehand object using the Points collection property.

Programmatically, the boundaries and location of the freehand hotspot object can be controlled using the following properties: Each object can be transformed with the following methods: The AnnFreehandHotspotObject 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 freehand hotspot object can be controlled using 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 AnnFreehandHotspotObject:

Example

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

JavaScript Example

example: function SiteLibrary_DefaultPage$example() { 
   // assumes _automation is valid 
   // Create a new instance of AnnResources if the container does not already have one 
   var resources = this._automation.get_container().get_resources(); 
   if (resources == null) { 
      resources = new lt.Annotations.Core.AnnResources(); 
      this._automation.get_container().set_resources(resources); 
   } 
   // Get the images collection 
   var imagesResources = resources.get_images(); 
   // Add our picture to it 
   imagesResources.add(new lt.Annotations.Core.AnnPicture("Resources/Objects/Hotspot.png")); 
   var pictureIndex = imagesResources.length - 1; 
 
   var inch = 720.0; 
   // Add a freehand hotspot object 
   var hotspotObj = new lt.Annotations.Core.AnnFreehandHotspotObject(); 
   // Set the points for the freehand hotspot 
   hotspotObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
   hotspotObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
   hotspotObj.get_points().add(lt.LeadPointD.create(1 * inch, 5 * inch)); 
   hotspotObj.get_points().add(lt.LeadPointD.create(5 * inch, 5 * inch)); 
   hotspotObj.get_points().add(lt.LeadPointD.create(4 * inch, 2 * inch)); 
   hotspotObj.get_points().add(lt.LeadPointD.create(5 * inch, 1 * inch)); 
   // Set the picture 
   hotspotObj.set_defaultPicture(pictureIndex); 
   // Set the hyperlink 
   hotspotObj.set_hyperlink("https://www.leadtools.com"); 
   // Add the object to the automation container 
   this._automation.get_container().get_children().add(hotspotObj); 
   // Select the object 
   this._automation.selectObject(hotspotObj); 
},