Overlay plugin object
More...
Inherits OverlayBase.
Inherited by ExtendedOverlayPluginBase< TData >, and SmartRectOverlay.
|
| OverlayPluginBase (string text, bool canDrag, Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag) |
| ctor for Overlay objects with user data More...
|
|
virtual OverlayPluginWrapper | CreateOverlayWrapper () |
| Overrideable creation function for overlay wrapper objects More...
|
|
override void | Overlay_ConnectedToDisplay () |
| Connect the overlay plugin to the display by means of an OPI wrapper
|
|
override void | Overlay_DisconnectedFromDisplay (bool handBackID) |
| Remove an OPI from a display (effectively: kill it...) More...
|
|
| OverlayBase (string text, bool canDrag, Color color, object tag) |
| ctor for DisplayObjects More...
|
|
|
OverlayPluginInfo | opiInfo_ |
| information about the OPI that is being used by this object
|
|
Point[] | vertices_ |
| Array with the most up-to-date construction vertices
|
|
Color | color_ = Color.White |
| Internally stored color.
|
|
|
string | Name [get] |
| Friendly name of the overlay plugin
|
|
virtual bool | Filled [get, set] |
| Specifies whether or not the OPI should be painted filled
|
|
virtual bool | XORPainting [get, set] |
| specifies the paint mode (opaque or XOR)
|
|
Display | Parent [get] |
| The display on which the label lives (if any...). Note that a label may only be associated with one display at a time
|
|
object | Tag [get, set] |
| Field for user-definable data to be associated with the overlay object.
|
|
bool | InvokeRequired [get] |
| tell whether actions on the display object require an invoke action or not (being user interface objects, display objects should not be modified asynchronously)
|
|
string | Text [get, set] |
| Text being displayed on the label and/or in the status line
|
|
virtual Color | Color [get, set] |
| Color of the label
|
|
bool | IsDragable [get, set] |
| Label dragable?
|
|
◆ OverlayPluginBase()
ctor for Overlay objects with user data
- Parameters
-
text | status line text |
canDrag | dragable flag |
color | color |
xorPaint | paint mode |
filled | paint mode |
vertices | vertices for the object |
info | opi info (GUID, friendly name) |
tag | object to be associated with this overlay |
- Exceptions
-
ArgumentException | If the information about the Overlay is missing (i.e. info equals OverlayInfo.Empty) |
ArithmeticException | If the number of vertices is insufficient for the overlay to be created. |
◆ Clone()
virtual copy constructor for overlay objects
- Returns
- The cloned overlay object.
Implemented in SmartRectOverlay.
◆ CreateOverlayWrapper()
virtual OverlayPluginWrapper CreateOverlayWrapper |
( |
| ) |
|
|
protectedvirtual |
◆ Overlay_DisconnectedFromDisplay()
override void Overlay_DisconnectedFromDisplay |
( |
bool |
handBackID | ) |
|
|
protectedvirtual |
Remove an OPI from a display (effectively: kill it...)
- Parameters
-
handBackID | true if the overlay's display ID is to be handed back to the display, false otherwise. |
- Exceptions
-
ObjectDisposedException | If the display we are trying to work on has already been disposed |
Implements OverlayBase.