selectionObject Property

Summary

Gets or sets the selection object used by this AnnContainer.

Syntax

JavaScript Syntax

Object.defineProperty(AnnContainer.prototype, 'selectionObject', 
	get: function(), 
	set: function(value) 
)

TypeScript Syntax

selectionObject: AnnSelectionObject;

Property Value

The AnnSelectionObject used by this AnnContainer. The default value is a new AnnSelectionObject instance with its Stroke set to a dark green AnnStroke object with length of 2. This value cannot be null.

Remarks

The selection object is always in the container and contains a collection (AnnSelectionObject.SelectedObjects) that holds references to the objects that are in a selected state. This object is used by the automation framework when multiple objects are selected and when drawing the selection "rectangle".

The style of this selection object can be changed from the default (dark green stroke of length 2) or you can derive your own custom object from AnnSelectionObject and use set it in this property.

The objects inside SelectionObject.SelectedObjects must be objects that already exist in the container, the automation frameworks keep this data in synch, therefore, use the AnnAutomation.SelectObject and AnnAutomation.SelectObjects methods to select and unselect objects from the container.

For more information, refer to the automation section in Programming with LEADTOOLS Annotations.

Example

JavaScript Example

example: function SiteLibrary_DefaultPage$example() { 
   // Get the selection object of the container 
   var container = this._automation.get_container(); 
   var selectionObject = container.get_selectionObject(); 
 
   // Change its stroke 
   selectionObject.set_stroke(lt.Annotations.Core.AnnStroke.create("black"), lt.LeadLengthD.create(1)); 
 
   alert("Use the new selection object now"); 
},

Requirements

Target Platforms

Reference

AnnContainer Class

AnnContainer Members

Leadtools.Annotations.Core Namespace

Help Version 19.0.2017.10.27

Leadtools.Annotations.Core Assembly

Introduction

Getting Started

Namespaces

Leadtools.Annotations.Core Namespace

Assemblies