LineOverlay Class Reference

A simple line overlay. More...

Inherits PenStyleOverlayPluginBase.

Public Member Functions
	LineOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point start, Point end, object tag)
	Constructor for Line plugins. More...
	LineOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point start, Point end)
	Constructor for Line plugins. More...
	LineOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point start, Point end, DashStyle dashStyle, int penWidth, object tag)
	Constructor for Line plugins. More...
	LineOverlay (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, Point start, Point end, DashStyle dashStyle, int penWidth)
	Constructor for Line plugins. More...
override OverlayPluginBase	Clone ()
	Copy Constructor. More...

Properties
override bool	Filled [get, set]
	Filled painting is not supported on this overlay plugin.
Point	Start [get, set]
	The start point of the line.
Point	End [get, set]
	The end point of the line.
Properties inherited from PenStyleOverlayPluginBase
int	PenWidth [get, set]
	Width of the pen to be used for painting. More...
DashStyle	DashStyle [get, set]
	Dash style to be used for painting. More...

Additional Inherited Members
Protected Member Functions inherited from PenStyleOverlayPluginBase
	PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	Constructor for pen-styled overlay plugins. More...
	PenStyleOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, DashStyle dashStyle, int penWidth, object tag)
	Constructor for pen-styled overlay plugins. More...
override PluginData.PenStylePlugInData	CreatePluginData ()
	Build the plugin data structure using the current settings. More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
	ExtendedOverlayPluginBase (string text, bool canDrag, System.Drawing.Color color, bool xorPaint, bool filled, Point[] vertices, OverlayPluginInfo info, object tag)
	Standard constructor for overlays with a plugin data structure. More...
override OverlayPluginWrapper	CreateOverlayWrapper ()
	overrideable creation function for overlay wrapper objects More...
abstract TData	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) More...
virtual void	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.
virtual void	OpiDataPropertyChanged (bool skipDestroyAndCreate)
	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. More...
Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.PenStylePlugInData >
TData	opiData_
	The plugin-specific data structure

Detailed Description

A simple line overlay.

Constructor & Destructor Documentation

LineOverlay() [1/4]

LineOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	start,
		Point	end,
		object	tag
	)

Constructor for Line plugins.

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
start	start point of the line
end	end point of the line
tag	object to be associated with this overlay

LineOverlay() [2/4]

LineOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	start,
		Point	end
	)

Constructor for Line plugins.

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
start	start point of the line
end	end point of the line

LineOverlay() [3/4]

LineOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	start,
		Point	end,
		DashStyle	dashStyle,
		int	penWidth,
		object	tag
	)

Constructor for Line plugins.

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
start	start point of the line
end	end point of the line
dashStyle	dash style for painting the line
penWidth	pen width for painting the line
tag	object to be associated with this overlay

Exceptions

ArgumentException

If penWidth is less than 0 or dashStyle is Custom

LineOverlay() [4/4]

LineOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		bool	xorPaint,
		Point	start,
		Point	end,
		DashStyle	dashStyle,
		int	penWidth
	)

Constructor for Line plugins.

Parameters

text	status line text
canDrag	dragable
color	color
xorPaint	paint mode
start	start point of the line
end	end point of the line
dashStyle	dash style for painting the line
penWidth	pen width for painting the line

Exceptions

ArgumentException

If penWidth is less than 0 or dashStyle is Custom

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Copy Constructor.

Returns

The cloned LineOverlay object.