AnnStickyNoteObject Object

Summary

Defines an annotation sticky note object.

Syntax
TypeScript
JavaScript
function lt.Annotations.Engine.AnnStickyNoteObject 
	extends lt.Annotations.Engine.AnnObject 
	implements IAnnObjectCloneable 
class lt.Annotations.Engine.AnnStickyNoteObject() 
	extends AnnObject 
	implements IAnnObjectCloneable 

Remarks

The sticky note object is a Picture rendered around single point (the center). This point is the first entry in the Points collection and all others are ignorred. This object does not support fill, stroke nor font.

This object supports using the SelectionStroke and by default when the value of IsSelected is true, it will use the stroke to draw a rectangle around the image instead of using a selection thumb.

With the automated functions, in design mode, the sticky point object is formed with a click or tap event.

Programmatically, the boundaries and location of the sticky note object can be controlled using the following properties: Each object can be transformed with the following methods: The AnnStickyNoteObject class inherits a number of properties from the AnnObject class, it does not support fill, stroke or font by overrides SupportsSelectionStroke to return true. The name of the sticky note 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 AnnStickyNoteObject:

Example

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

TypeScript
JavaScript
// assumes _automation is valid 
// Create a new instance of AnnResources if the automation manager does not already have one 
var resources = this._automation.get_manager().get_resources(); 
if (resources == null) { 
   resources = new lt.Annotations.Engine.AnnResources(); 
   this._automation.get_manager().set_resources(resources); 
} 
// Get the images collection 
var imagesResources = resources.get_images(); 
// Add our picture to it 
imagesResources.add(new lt.Annotations.Engine.AnnPicture("Resources/Objects/StickyNote.png")); 
var pictureIndex = imagesResources.length - 1; 
 
// assumes _automation is valid 
var inch = 720.0; 
    
// Add a sticky note object 
var annObj = new lt.Annotations.Engine.AnnStickyNoteObject(); 
    
// Set the points for the hotspot 
annObj.get_points().add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
annObj.get_points().add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
annObj.get_points().add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
annObj.get_points().add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
    
// Set the picture 
annObj.set_defaultPicture(pictureIndex); 
    
// Add the object to the automation container 
this._automation.get_container().get_children().add(annObj); 
    
// Select the object 
this._automation.selectObject(annObj); 
 
// Hook to rendering engine loadPicture event to render the container immediately after resources get loaded 
var automation = this._automation; 
automation.get_manager().renderingEngine.add_loadPicture(function(sender, e) { 
  automation.invalidate(lt.LeadRectD.empty); 
 }); 
// assumes _automation is valid 
// Create a new instance of AnnResources if the automation manager does not already have one 
let resources: lt.Annotations.Engine.AnnResources = this._automation.manager.resources; 
if (resources == null) { 
   resources = new lt.Annotations.Engine.AnnResources(); 
   this._automation.manager.resources = resources; 
} 
// Get the images collection 
const imagesResources: lt.Annotations.Engine.AnnPicture[] = resources.images; 
// Add our picture to it 
imagesResources.push(new lt.Annotations.Engine.AnnPicture("Resources/Objects/StickyNote.png")); 
const pictureIndex: number = imagesResources.length - 1; 
 
// assumes _automation is valid 
const inch: number = 720.0; 
 
// Add a sticky note object 
const annObj: lt.Annotations.Engine.AnnStickyNoteObject = new lt.Annotations.Engine.AnnStickyNoteObject(); 
 
// Set the points for the hotspot 
annObj.points.add(lt.LeadPointD.create(1 * inch, 1 * inch)); 
annObj.points.add(lt.LeadPointD.create(2 * inch, 1 * inch)); 
annObj.points.add(lt.LeadPointD.create(2 * inch, 2 * inch)); 
annObj.points.add(lt.LeadPointD.create(1 * inch, 2 * inch)); 
 
// Set the picture 
annObj.defaultPicture = pictureIndex; 
 
// Add the object to the automation container 
this._automation.container.children.add(annObj); 
 
// Select the object 
this._automation.selectObject(annObj); 
 
// Hook to rendering engine loadPicture event to render the container immediately after resources get loaded 
const automation: lt.Annotations.Automation.AnnAutomation = this._automation; 
automation.manager.renderingEngine.add_loadPicture((sender, e) => { 
   automation.invalidate(lt.LeadRectD.empty); 
}); 

Requirements

Target Platforms

Help Version 20.0.2019.3.11
Products | Support | Contact Us | Intellectual Property Notices
© 1991-2019 LEAD Technologies, Inc. All Rights Reserved.

Leadtools.Annotations.Engine Assembly