OverlayPluginBase Class

CVB.Net Documentation

Overlay plugin object

Inheritance Hierarchy

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

Syntax

public abstract class OverlayPluginBase : OverlayBase

Public MustInherit Class OverlayPluginBase
	Inherits OverlayBase

public ref class OverlayPluginBase abstract : public OverlayBase

[<AbstractClassAttribute>]
type OverlayPluginBase =  
    class
        inherit OverlayBase
    end

The OverlayPluginBase type exposes the following members.

Constructors

	Name	Description
	OverlayPluginBase	ctor for Overlay objects with user data

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	Specifies whether or not the OPI should be painted filled
	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.)
	Name	Friendly name of the overlay plugin
	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.)
	XORPainting	specifies the paint mode (opaque or XOR)

Methods

	Name	Description
	Clone	virtual copy constructor for overlay objects
	CreateOverlayWrapper	Overrideable creation function for overlay wrapper objects
	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	Determines whether the specified Object is equal to the current Object. (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.)
	Overlay_ConnectedToDisplay	Connect the overlay plugin to the display by means of an OPI wrapper (Overrides OverlayBaseOverlay_ConnectedToDisplay.)
	Overlay_DisconnectedFromDisplay	Remove an OPI from a display (effectively: kill it...) (Overrides OverlayBaseOverlay_DisconnectedFromDisplay(Boolean).)
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Fields

	Name	Description
	color_	Internally stored color. (Inherited from OverlayBase.)
	opiInfo_	information about the OPI that is being used by this object
	vertices_	Array with the most up-to-date construction vertices