ExtendedOverlayPluginBaseTData Class

CVB.Net Documentation

Base class for all overlays that come with a plugin data structure

Inheritance Hierarchy

SystemObject
  Stemmer.Cvb.Forms.OverlaysOverlayBase
    Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
      Stemmer.Cvb.Forms.OverlaysExtendedOverlayPluginBaseTData
        More...

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

Syntax

C++

Copy

public abstract class ExtendedOverlayPluginBase<TData> : OverlayPluginBase
where TData : struct, new()

Public MustInherit Class ExtendedOverlayPluginBase(Of TData As {Structure, New})
	Inherits OverlayPluginBase

generic<typename TData>
where TData : value class, gcnew()
public ref class ExtendedOverlayPluginBase abstract : public OverlayPluginBase

[<AbstractClassAttribute>]
type ExtendedOverlayPluginBase<'TData when 'TData : struct, new()> =  
    class
        inherit OverlayPluginBase
    end

Type Parameters

TData: Type of the information container for the plugin.

The ExtendedOverlayPluginBaseTData type exposes the following members.

Constructors

	Name	Description
	ExtendedOverlayPluginBaseTData	Standard constructor for overlays with a plugin data structure.

Top

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 (Inherited from OverlayPluginBase.)
	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 (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.)
	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) (Inherited from OverlayPluginBase.)

Top

Methods

	Name	Description
	Clone	virtual copy constructor for overlay objects (Inherited from OverlayPluginBase.)
	CreateOverlayWrapper	overrideable creation function for overlay wrapper objects (Overrides OverlayPluginBaseCreateOverlayWrapper.)
	CreatePluginData	Inheritors must override this and in the override prepare the plugin data reflecting the OPI's current state (depending usually on the current values of the Overlay object's properties)
	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.)
	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.
	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.
	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.)

Top

Fields

	Name	Description
	color_	Internally stored color. (Inherited from OverlayBase.)
	opiData_	The plugin-specific data structure
	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.)

Top

Reference

Stemmer.Cvb.Forms.Overlays Namespace

Inheritance Hierarchy

ExtendedOverlayPluginBaseAddLanguageSpecificTextSet("LSTC3F21EDA_0?cs=&lt;|vb=(Of |cpp=&lt;|fs=&lt;'|nu=(");TDataAddLanguageSpecificTextSet("LSTC3F21EDA_1?cs=&gt;|vb=)|cpp=&gt;|fs=&gt;|nu=)"); Class

Type Parameters

Reference

ExtendedOverlayPluginBaseTData Class