Description

The overlay manager class.

Remarks

These objects implement the McGraphOverlay interface and are an event source for the _McGraphOverlayEvents interface. They also implement the standard IPersistStorage and IPersistStream interfaces, which are used by the Load and Save methods to serialize McOverlay objects.

McGraphOverlay instances are exposed as McImage.AnnotationOverlay and McImage.ImageToolsOverlay. They are also exposed as well as members of the IMcFeatures.DisplayOverlays collection for graphical representation of McRegions, McLines and McPoints.

Members

Methods
Add

Create and add a new McGraphObj to the collection.

BurnIntoImage

Does a burn-in operation onto the McImageDst.

Deselect

Deselect a graphic object or all selected objects.

EditClear

Delete the current selection and remove it from this overlay collection.

EditCopy

Copy the current selection to the clipboard. compatible data.

EditCut

Cut the current selection and put it in the clipboard. compatible data.

EditPaste

Paste the contents of the clipboard if any to this overlay.

EditProperties

Brings up the Properties dialog for the selected graph object.

GetItemFromDrawingOrder

Returns a graphic object from the collection based on its DrawingOrder property value.

Import

Import graphic object(s) from another overlay collection.

IsActionAvailable

A read-only boolean value indicating whether a specified action can be performed.

Load

Load a previously saved overlay collection.

MapImageToZoomed

Convert image coordinates to screen coordinates in the active view.

MapZoomedToImage

Convert image coordinates to screen coordinates in the active view.

MoveBackward

Modify the Z ordering by moving backward the designated object(s).

MoveForward

Modify the Z ordering by moving forward the designated object(s).

MoveSelectedObjects

The position of the selected graph object(s) is moved by a given offset.

MoveToBack

Modify the Z ordering by moving the designated object(s) to the bottom of the Z stack.

MoveToFront

Modify the Z ordering by moving the designated object(s) to the top of the Z stack.

Remove

Remove one graphic object from the collection.

RemoveAll

Remove all visible graphic objects from the collection.

Save

Save an overlay collection.

Select

Select one or all graphic objects or a group of objects.

SelectTool

Select a graphic tool used to create and manipulate graphic objects.

SetEnumFilter

Select the objects enumerated by _NewEnum.


Properties
ActiveToolRead-only property

Exposes an McGraphToolServer instance for the currently active tool.

ClipboardDataAvailableRead-only property

A read-only boolean value indicating whether the clipboard contains overlay compatible data.

ClipboardNameRead-only property

A read-only property giving the default ClipFormatName used by EditCopy/Cut/Paste.

CountRead-only property

The number of graphic objects in this collection.

DisplayRead-only propertyDisplay Operator
ItemRead-only property

Returns one graphic object from the collection based on its ID value or its position, or Nothing if the object cannot be found.

ModifiedRead-only property

Read-only property indicating whether one of the graphic objects contained in this overlay collection has been modified since the last Save.

NameRead-write property

A read/write property used to associate a name with the overlay object.

NotifyContextRead-write property

When a notify is in progress, gives the notify depth and indicates if the notify was caused by some user action.

PropertySheetLeftRead-write property

X coordinate of the left upper corner of this overlay's property sheet.

PropertySheetTitleRead-write property

Title of this overlay's property sheet.

PropertySheetTopRead-write property

Y coordinate of the left upper corner of this overlay's property sheet.

SelectedCountRead-only property

Read only property returning the number of selected objects.

SelectedGraphObjRead-only property

The first selected McGraphObj, or optionally, the selected McGraphObj at a given index.

TemplateRead-only property

Read-only property used to access the graphic object templates.

ViewsRead-only property

Readonly property exposing the overlay controlled McViews collection.

VisibleRead-write property

Read/write property indicating whether this overlay is visible or not.


Events
AboutToBeDestroyed

This McOverlay instance is in the process of being destroyed.

EditClear

This Object is about to be deleted as part of an EditClear or EditCut operation.

EditCopy

This object is going to be copied to the clipboard.

EditPaste

This object was just pasted from the clipboard.

MoveSelected

The selected object(s) are about to be moved or have just been moved.

ObjectAboutToBeDeleted

This Object is about to be deleted by the user (using the DEL key).

ObjectAboutToBeDestroyed

This Object is about to be destroyed by any means. A previous ObjectAboutToBeDeleted or EditClear event may have been fired for this object if it was being deleted during user editing or an EditClear/Cut respectively.

ObjectCreated

This object was just created.

ObjectDeselected

Object has been deselected.

ObjectDragged

This object is being dragged.

ObjectHandleDragged

One of this object's handles is being dragged.

ObjectHandleMoved

One of this object's handles was moved.

ObjectMoved

This Object was moved.

ObjectPropertyChanged

This Object's property identified by propertyId was changed. Or an attempt to edit properties could not be honored.

ObjectSelected

Object was just selected.

ObjectUsedAsDefault

This Object properties were copied to its template.

ToolDeselected

A tool was just deselected, and is not active anymore. If any tool was active, this event is always sent to notify clients of the overlay that selected the previously active tool. It is also sent to the notify clients of the overlay getting a newly selected tool or no tool.

ToolSelected

Tool was selected as the new active tool.