A polygon overlay.
Inheritance Hierarchy
Stemmer.Cvb.Forms.OverlaysOverlayBase
Stemmer.Cvb.Forms.OverlaysOverlayPluginBase
Stemmer.Cvb.Forms.OverlaysExtendedOverlayPluginBasePolyLinePlugInData
Stemmer.Cvb.Forms.OverlaysPolyLineOverlay
Namespace: Stemmer.Cvb.Forms.Overlays
Assembly: Stemmer.Cvb.Forms (in Stemmer.Cvb.Forms.dll) Version: 14.0.0.0
Syntax
public class PolyLineOverlay : ExtendedOverlayPluginBase<PolyLinePlugInData>, ICollection<Point>, IEnumerable<Point>, IEnumerable
The PolyLineOverlay type exposes the following members.
Constructors
Name | Description | |
---|---|---|
PolyLineOverlay(String, Boolean, Color, Int32, DashStyle, Point) |
Standard constructor for Polyline overlays.
| |
PolyLineOverlay(String, Boolean, Color, Int32, DashStyle, Point, Object) |
Standard constructor for Polyline overlays.
|
Properties
Name | Description | |
---|---|---|
Color |
Color of the label
(Inherited from OverlayBase.) | |
Count |
number of pixels currently in the list (it is sufficient to give the
count of pl since the last pixel list generation because user
interaction cannot change the number of elements
| |
DashStyle |
Dash style to be used for painting.
| |
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.) | |
IsReadOnly |
tell that this collection can be read and written
| |
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.) | |
PenWidth |
Width of the pen to be used for painting.
| |
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.) |
Methods
Name | Description | |
---|---|---|
Add |
Add a new pixel to the polygon plugin
| |
Clear |
remove all pixel from the pixel list plugin
| |
Clone |
Virtual copy Constructor.
(Overrides OverlayPluginBaseClone.) | |
Contains |
Contains method of the ICollection interface - check if a pixel is
part of the collection
| |
CopyTo |
copy the contents of the polygon into an array starting at a given
array index
| |
CreateOverlayWrapper |
overrideable creation function for overlay wrapper objects
(Inherited from ExtendedOverlayPluginBaseTData.) | |
CreatePluginData |
Create the plugin data structure for later use
(Overrides ExtendedOverlayPluginBaseTDataCreatePluginData.) | |
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 | (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.) | |
GetEnumerator |
Enumeration implementation
| |
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.
(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.) | |
Remove |
remove all instances of a given pixel from the polygon
| |
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.) |
Explicit Interface Implementations
Name | Description | |
---|---|---|
IEnumerableGetEnumerator |
inner IEnumerator
|
See Also