A label with selectable font properties (note: not all available font
attributes are supported...).
Inheritance Hierarchy
Stemmer.Cvb.Forms.OverlaysOverlayBase
Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
Stemmer.Cvb.Forms.OverlaysExtendedOverlayPluginBaseTextOutPlugInData
Stemmer.Cvb.Forms.OverlaysTextOverlay
Namespace: Stemmer.Cvb.Forms.Overlays
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax
The TextOverlay type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
 | TextOverlay(String, Boolean, Color, Point, Font, Boolean, Double) |
Constructor for text overlays
|
| TextOverlay(String, Boolean, Color, Point, Font, Boolean, Double, Object) |
Constructor for text overlays
|
Properties
| Name | Description | |
|---|---|---|
 | Color |
Color of the label
(Inherited from OverlayBase.) |
 | DisplayID |
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.) |
| Filled |
Filled property is always false on this overlay.
|
| Font |
Font to be used for the text.
|
| 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.) |
| Location |
Position of the text.
|
| Name |
Friendly name of the overlay plugin
(Inherited from OverlayPluginBase.) |
| 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.) |
| Rotation |
Rotation of the text in radians.
|
| ShowFocus |
Show or hide the focus point of the text overlay.
|
| 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.) |
| XORPainting |
XOR painting is not possible...
|
Methods
| Name | Description | |
|---|---|---|
| Clone |
Virtual copy Constructor
(Overrides OverlayPluginBaseClone.) |
 | CreateOverlayWrapper |
overrideable creation function for overlay wrapper objects
(Inherited from ExtendedOverlayPluginBaseTData.) |
| CreatePluginData |
Create the plugin data structure according to the current set of
properties.
(Overrides ExtendedOverlayPluginBaseTDataCreatePluginData.) |
| DestroyAndCreatePropertyChanged |
hook into the DestroyAndCreatePropertyChanged handling to make sure
the Text field of the opiData struct contains up-to-date info
(Overrides OverlayBaseDestroyAndCreatePropertyChanged.) |
| 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 |
hook into the "ConnectToDisplay" method to patch the problem that the
OPI only paints its cross hair but not the text upon first
instantiation
(Overrides OverlayBaseOnConnectToDisplay(Display).) |
| OnDisconnectFromDisplay |
Disconnect the object from its parent display.
(Inherited from OverlayBase.) |
| OpiDataPropertyChanged |
A property that is relevant for the opi data structure has been
changed; as a consequence, the opi may potentially need to be
re-generated in order to reflect the changes.
(Inherited from ExtendedOverlayPluginBaseTData.) |
| OpiDataPropertyChanged(Boolean) |
A property that is relevant for the opi data structure has been
changed; as a consequence, the opi may potentially need to be
re-generated in order to reflect the changes.
(Inherited from ExtendedOverlayPluginBaseTData.) |
| Overlay_ConnectedToDisplay |
Connect the overlay plugin to the display by means of an OPI wrapper
(Inherited from OverlayPluginBase.) |
| Overlay_DisconnectedFromDisplay |
Remove an OPI from a display (effectively: kill it...)
(Inherited from OverlayPluginBase.) |
| ToString | Returns a string that represents the current object. (Inherited from Object.) |
Fields
| Name | Description | |
|---|---|---|
 | color_ |
Internally stored color.
(Inherited from OverlayBase.) |
| opiData_ |
The plugin-specific data structure
(Inherited from ExtendedOverlayPluginBaseTData.) |
| opiInfo_ |
information about the OPI that is being used by this object
(Inherited from OverlayPluginBase.) |
| vertices_ |
Array with the most up-to-date construction vertices
(Inherited from OverlayPluginBase.) |
See Also