FixedSizeBitmapOverlay Class

CVB.Net Documentation
A "target" - in principle a stack of crosshair plugins
Inheritance Hierarchy

SystemObject
  Stemmer.Cvb.Forms.OverlaysOverlayBase
    Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
      Stemmer.Cvb.Forms.OverlaysExtendedOverlayPluginBaseBitmapPlugInData
        Stemmer.Cvb.Forms.OverlaysFixedSizeBitmapOverlay

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

public class FixedSizeBitmapOverlay : ExtendedOverlayPluginBase<BitmapPlugInData>

The FixedSizeBitmapOverlay type exposes the following members.

Constructors

  NameDescription
Public methodFixedSizeBitmapOverlay(String, Boolean, Point, Bitmap)
Standard constructor for bitmap overlays that will not change in size regardless of the current zoom level.
Public methodFixedSizeBitmapOverlay(String, Boolean, Point, Bitmap, Object)
Standard constructor for bitmap overlays that will not change in size regardless of the current zoom level.
Top
Properties

  NameDescription
Public propertyBitmap
Bitmap to be displayed
Public propertyColor
Setting any other color than black is not possible for this overlay.
Protected propertyDisplayID
The ID under which the unmanaged display "knows" the label
(Inherited from OverlayBase.)
Public propertyFilled
Filled property is always true on this overlay.
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)
(Inherited from OverlayBase.)
Public propertyIsDragable
Label dragable?
(Inherited from OverlayBase.)
Public propertyLocation
position of the left top corner of the bitmap
Public propertyName
Friendly name of the overlay plugin
(Inherited from OverlayPluginBase.)
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
(Inherited from OverlayBase.)
Public propertyTag
Field for user-definable data to be associated with the overlay object.
(Inherited from OverlayBase.)
Public propertyText
Text being displayed on the label and/or in the status line
(Inherited from OverlayBase.)
Public propertyXORPainting
XOR painting is not possible...
Top
Methods

  NameDescription
Public methodClone
Virtual copy Constructor.
(Overrides OverlayPluginBaseClone.)
Protected methodCreateOverlayWrapper
overrideable creation function for overlay wrapper objects
(Inherited from ExtendedOverlayPluginBaseTData.)
Protected methodCreatePluginData
Create the plugin data structure for later use
(Overrides ExtendedOverlayPluginBaseTDataCreatePluginData.)
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.
(Inherited from OverlayBase.)
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.
(Inherited from OverlayBase.)
Protected methodOnDisconnectFromDisplay
Disconnect the object from its parent display.
(Inherited from OverlayBase.)
Protected methodOpiDataPropertyChanged
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.)
Protected methodOpiDataPropertyChanged(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.)
Protected methodOverlay_ConnectedToDisplay
Connect the overlay plugin to the display by means of an OPI wrapper
(Inherited from OverlayPluginBase.)
Protected methodOverlay_DisconnectedFromDisplay
Remove an OPI from a display (effectively: kill it...)
(Inherited from OverlayPluginBase.)
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Top
Fields

  NameDescription
Protected fieldcolor_
Internally stored color.
(Inherited from OverlayBase.)
Protected fieldopiData_
The plugin-specific data structure
(Inherited from ExtendedOverlayPluginBaseTData.)
Protected fieldopiInfo_
information about the OPI that is being used by this object
(Inherited from OverlayPluginBase.)
Protected fieldvertices_
Array with the most up-to-date construction vertices
(Inherited from OverlayPluginBase.)
Top
See Also

Reference