OverlayBase Class

CVB.Net Documentation
Base object for all displayable objects (currently labels and overlay plug in objects)
Inheritance Hierarchy

SystemObject
  Stemmer.Cvb.Forms.OverlaysOverlayBase
    Stemmer.Cvb.Forms.OverlaysDisplayLabel
    Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
    Stemmer.Cvb.Forms.OverlaysUserOverlay

Namespace:  Stemmer.Cvb.Forms.Overlays
Assembly:  Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax

public abstract class OverlayBase

The OverlayBase type exposes the following members.

Constructors

  NameDescription
Protected methodOverlayBase
ctor for DisplayObjects
Top
Properties

  NameDescription
Public propertyColor
Color of the label
Protected propertyDisplayID
The ID under which the unmanaged display "knows" the label
Public propertyInvokeRequired
tell whether actions on the display object require an invoke action or not (being user interface objects, display objects should not be modified asynchronously)
Public propertyIsDragable
Label dragable?
Public propertyParent
The display on which the label lives (if any...). Note that a label may only be associated with one display at a time
Public propertyTag
Field for user-definable data to be associated with the overlay object.
Public propertyText
Text being displayed on the label and/or in the status line
Top
Methods

  NameDescription
Protected methodDestroyAndCreatePropertyChanged
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.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object.)
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnConnectToDisplay
Establish connection with a new display.
Protected methodOnDisconnectFromDisplay
Disconnect the object from its parent display.
Protected methodOverlay_ConnectedToDisplay
The actual display connection needs to be established inside this function!
Protected methodOverlay_DisconnectedFromDisplay
The actual disconnection needs to be coded inside this function!
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields

  NameDescription
Protected fieldcolor_
Internally stored color.
Top
See Also

Reference