SetId Method

Summary

Sets the ID of this AnnObject.

Syntax

Java

Objective-C

WinRT C#

C++

public void SetId( 
   int id 
)

Public Sub SetId( _ 
   ByVal id As Integer _ 
)

public void SetId(  
   int id 
)

-(void) setID:(int) anID;

public void setId(int id)

 function Leadtools.Annotations.Core.AnnObject.SetId(  
   id  
)

public:  
   void SetId( 
      Int32 id 
   )

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 will call this method with id 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