User-definable overlay. This type of overlay does not use a predefined
appearance, but needs to be user-drawn using a subset of the GDI
functionality exported by the
UnmanagedGraphics object.
Inheritance Hierarchy
Stemmer.Cvb.Forms.OverlaysOverlayBase
Stemmer.Cvb.Forms.OverlaysUserOverlay
Stemmer.Cvb.Forms.VisualToolsVisualToolBaseTResult
Namespace: Stemmer.Cvb.Forms.Overlays
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax
The UserOverlay type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | UserOverlay(UserOverlay) |
copy ctor
|
| UserOverlay(String, Boolean, Boolean, Color, Boolean, Point, Cursor) |
Construct a user object.
|
| UserOverlay(String, Boolean, Boolean, Color, Boolean, Point, Cursor, Object) |
Construct a user object.
|
Properties
| Name | Description | |
|---|---|---|
 | Color |
Color of the overlay.
(Overrides OverlayBaseColor.) |
 | DisplayID |
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.) |
| InvokeRequired |
tell whether actions on the display object require an invoke action
or not (being user interface objects, display objects should not be
modified asynchronously)
(Inherited from OverlayBase.) |
| IsDragable |
Label dragable?
(Inherited from OverlayBase.) |
| Parent |
The display on which the label lives (if any...). Note that a label
may only be associated with one display at a time
(Inherited from OverlayBase.) |
| Tag |
Field for user-definable data to be associated with the overlay
object.
(Inherited from OverlayBase.) |
| Text |
Text being displayed on the label and/or in the status line
(Inherited from OverlayBase.) |
| Vertices |
Pixel positions to paint the user object with. Modifying the Vertex
positions will not change the appearance of the overlay and the
changes will in fact be overwritten in the next Paint event.
Positions are in image coordinates, NOT in client coordinates.
|
| XORPaint |
Use or don't use XOR mode for painting.
|
Methods
| Name | Description | |
|---|---|---|
 | DestroyAndCreatePropertyChanged |
Method to be called whenever a property value changed that
necessitates a destroy + create in order to reflect the property
change on the actual display.
(Inherited from OverlayBase.) |
| Equals | (Inherited from Object.) |
| Finalize | Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object.) |
| GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
| GetType | Gets the Type of the current instance. (Inherited from Object.) |
| MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
| OnConnectToDisplay |
Establish connection with a new display.
(Inherited from OverlayBase.) |
| OnDisconnectFromDisplay |
Disconnect the object from its parent display.
(Inherited from OverlayBase.) |
| OnPaint |
Inheritors may override this method to change behavior.
|
| Overlay_ConnectedToDisplay |
Add a label to a display.
(Overrides OverlayBaseOverlay_ConnectedToDisplay.) |
| Overlay_DisconnectedFromDisplay |
Remove a label from its display
(Overrides OverlayBaseOverlay_DisconnectedFromDisplay(Boolean).) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Events
| Name | Description | |
|---|---|---|
 | Paint |
Paint event that will be raised if the object needs to be painted.
|
Fields
| Name | Description | |
|---|---|---|
 | color_ |
Internally stored color.
(Inherited from OverlayBase.) |
See Also