RemoveObject Method

void RemoveObject( 
   AnnObject annObject
)

Sub RemoveObject( _
   ByVal annObject As AnnObject _
) 

void RemoveObject( 
   AnnObject annObject
)

void removeObject(AnnObject annObject);

function Leadtools.Annotations.Core.IAnnObjectRenderer.RemoveObject( 
   annObject 
)

Parameters

annObject

The annotation object being removed.

This method should be implemented by state renderers to add the equivalent element for the annotation object.

The rendering engine will call AddObject when the annotation object is first rendered to a container. The object renderer should create the equiavalent state element (such as an SVG or XAML element) for the object at this point. It is best to use AnnObject.StateId to store the state (or element) ID at this point inside the object.

The engine will then call Render every time the object is changed. The object renderer can obtain the equivalent element using AnnObject.StateId and update it at this point.

When an annotation object is removed from the container, the rendering engine will call RemoveObject. The object renderer must then remove the object state (element) using AnnObject.StateId.

Implement this method only when you have a state rendering engine, such as SVG or XAML renderers. In stateless rendering engines, such as GDI+, you should implement this method but leave it empty.

For an example, refer to Implementing XAML-based AnnObjectRenderer in WinRT (Windows Store).

Target Platforms

Reference

IAnnObjectRenderer Interface
IAnnObjectRenderer Members