TextOverlay Class Reference

A label with selectable font properties (note: not all available font attributes are supported...). More...

Inherits ExtendedOverlayPluginBase< PluginData.TextOutPlugInData >.

Public Member Functions
	TextOverlay (string text, bool canDrag, System.Drawing.Color color, Point location, Font font, bool showMarker, double rotation, object tag)
	Constructor for text overlays More...
	TextOverlay (string text, bool canDrag, System.Drawing.Color color, Point location, Font font, bool showMarker, double rotation)
	Constructor for text overlays More...
override OverlayPluginBase	Clone ()
	Virtual copy Constructor More...

Protected Member Functions
override PluginData.TextOutPlugInData	CreatePluginData ()
	Create the plugin data structure according to the current set of properties. More...
Protected Member Functions inherited from ExtendedOverlayPluginBase< PluginData.TextOutPlugInData >
	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...

Properties
new bool	XORPainting [get, set]
	XOR painting is not possible... More...
new bool	Filled [get, set]
	Filled property is always false on this overlay. More...
Point	Location [get, set]
	Position of the text.
Font	Font [get, set]
	Font to be used for the text.
bool	ShowFocus [get, set]
	Show or hide the focus point of the text overlay.
double	Rotation [get, set]
	Rotation of the text in radians.

Additional Inherited Members
Protected Attributes inherited from ExtendedOverlayPluginBase< PluginData.TextOutPlugInData >
TData	opiData_
	The plugin-specific data structure

Detailed Description

A label with selectable font properties (note: not all available font attributes are supported...).

Constructor & Destructor Documentation

TextOverlay() [1/2]

TextOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		Point	location,
		Font	font,
		bool	showMarker,
		double	rotation,
		object	tag
	)

Constructor for text overlays

Parameters

text	status line string
canDrag	dragable or not
color	color
location	label's top left position
font	font for drawing the label (note that some of the font properties are ignored)
showMarker	show a crosshair on the focus point?
rotation	rotation of the text (in radians)
tag	object to be associated with this overlay

TextOverlay() [2/2]

TextOverlay	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		Point	location,
		Font	font,
		bool	showMarker,
		double	rotation
	)

Constructor for text overlays

Parameters

text	status line string
canDrag	dragable or not
color	color
location	label's top left position
font	font for drawing the label (note that some of the font properties are ignored)
showMarker	show a crosshair on the focus point?
rotation	rotation of the text (in radians)

Member Function Documentation

Clone()

override OverlayPluginBase Clone

(

)

Virtual copy Constructor

Returns

The cloned TextOverlay object.

CreatePluginData()

override PluginData.TextOutPlugInData CreatePluginData ( )

protectedvirtual

Create the plugin data structure according to the current set of properties.

Returns

The overlay plugin data structure.

Implements ExtendedOverlayPluginBase< PluginData.TextOutPlugInData >.

Property Documentation

Filled

new bool Filled

getset

Filled property is always false on this overlay.

Exceptions

NotSupportedException

when trying to set a value of "true".

XORPainting

new bool XORPainting

getset

XOR painting is not possible...

Exceptions

NotSupportedException

when trying to set true (inheritance dictates that a set accessor needs to be present).