setId Method

Summary

Sets the ID of this AnnObject.

Syntax
TypeScript
JavaScript
AnnObject.prototype.setId = function( 
   id 
) 
setId( 
   id: number 
): void; 

Parameters

id

The object ID.

Remarks

This method should be called by derived class to set the ID of this object. This value will then identity this object type for all future use. For example, the AnnRectangleObject equals to RectangleObjectId while AnnTextObject will use TextObjectId. The value of this ID can be obtained later through the Id property.

The ID is used by other parts of the annotations framework to identify object types, for example, in the automation toolkit, the ID is used as the current object type to draw.

When deriving your own class from AnnObject, you must call override this method to return a unique ID for your object type. For more information, refer to Implementing User-Defined Objects With LEADTOOLS Annotations.

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