AnnHotspotObject Class

Summary

Defines an annotation hot spot object.

Syntax

Objective-C

C++/CLI

Java

Python

public class AnnHotspotObject : AnnImageObject

@interface LTAnnHotspotObject : LTAnnImageObject<NSCoding, NSCopying>

public class AnnHotspotObject extends AnnImageObject

public: 
   ref class AnnHotspotObject : AnnImageObject

class AnnHotspotObject(AnnImageObject):

Remarks

The AnnHotspotObject object is designed to work as a scaled picture drawn inside a rectangle. The AnnHotspotObject object will draw the picture if the owner container is in design mode. If the container is in run mode, the AnnHotspotObject object will not draw the picture.

With the automated functions, in design mode, the rectangle contains a scaled image. The user clicks / taps and drags to specify the rectangle in the current window. In run mode, the object is transparent, but the mouse pointer changes to a hand when it is over the object.

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

Each object can be transformed with the following methods:

The AnnHotspotObject 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 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 AnnHotspotObject:

Example

This example creates a 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_AnnHotspotObject() 
{ 
   // 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 hotspot object 
   AnnHotspotObject hotspotObj = new AnnHotspotObject(); 
   // Set the points for the hotspot 
   hotspotObj.Points.Add(LeadPointD.Create(1 * inch, 1 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(2 * inch, 1 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(2 * inch, 2 * inch)); 
   hotspotObj.Points.Add(LeadPointD.Create(1 * inch, 2 * inch)); 
   // Set the picture 
   hotspotObj.DefaultPicture = pictureIndex; 
   // Add the object to the automation container 
   _automation.Container.Children.Add(hotspotObj); 
}

Requirements

Target Platforms

Reference

AnnHotspotObject 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