AnnFreehandHotspotObject Class

Summary

Defines an annotation freehand hot spot object.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnFreehandHotspotObject : AnnPolylineObject

@interface LTAnnFreehandHotspotObject : LTAnnPolylineObject<NSCoding, NSCopying>

public class AnnFreehandHotspotObject extends AnnPolylineObject

public: 
   ref class AnnFreehandHotspotObject : AnnPolylineObject

class AnnFreehandHotspotObject(AnnPolylineObject):

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 AnnObject.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 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 AnnFreehandHotspotObject:

Example

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

using Leadtools.Annotations.Automation; 
using Leadtools.Annotations.Engine; 
using Leadtools.Codecs; 
using Leadtools.Annotations; 
using Leadtools.Annotations.WinForms; 
 
public void AnnCore_AnnFreehandHotspotObject() 
{ 
   // assumes _automation is valid 
   // Create a new instance of AnnResources if the container does not already have one 
   AnnResources resources = _automation.Manager.Resources; 
   if (resources == null) 
   { 
      resources = new AnnResources(); 
   } 
   // Get the images collection 
   IList<AnnPicture> imagesResources = resources.Images; 
   // Add our picture to it 
   imagesResources.Add(new AnnPicture(@"ms-appx:///Assets/Hotspot.png")); 
   int pictureIndex = imagesResources.Count - 1; 
 
   double inch = 720.0; 
   // Add a freehand hotspot object 
   AnnFreehandHotspotObject hotspotObj = new AnnFreehandHotspotObject(); 
   // Set the points for the freehand hotspot 
   hotspotObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(1 * inch, 5 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(5 * inch, 5 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(4 * inch, 2 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(5 * inch, 1 * inch)); 
   // Set the picture 
   hotspotObj.DefaultPicture = pictureIndex; 
   // Set the hyperlink 
   hotspotObj.Hyperlink = "https://www.leadtools.com"; 
   // Add the object to the automation container 
   _automation.Container.Children.Add(hotspotObj); 
}

Requirements

Target Platforms

Reference

AnnFreehandHotspotObject Members

Leadtools.Annotations.Engine Namespace

Download our FREE evaluation

Help Version 23.0.2024.2.29

Leadtools.Annotations.Engine Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Engine Namespace

Assemblies