DisplayLabel Class Reference

Display Label. More...

Inherits OverlayBase.

Public Member Functions
	DisplayLabel (string text, bool canDrag, System.Drawing.Color color, Point pos)
	Construct a display label. More...
	DisplayLabel (string text, bool canDrag, System.Drawing.Color color, Point pos, object tag)
	Construct a display label. More...
	DisplayLabel (DisplayLabel obj)
	Copy constructor. More...

Protected Member Functions
override void	Overlay_ConnectedToDisplay ()
	Add a label to a display. More...
override void	Overlay_DisconnectedFromDisplay (bool handBackID)
	Remove a label from its display More...
Protected Member Functions inherited from OverlayBase
	OverlayBase (string text, bool canDrag, System.Drawing.Color color, object tag)
	ctor for DisplayObjects More...

Properties
Point	Location [get, set]
	Pixel position of the label (in pixels of the image that is currently being displayed).
Properties inherited from OverlayBase
Display	Parent [get]
	The display on which the label lives (if any...). Note that a label may only be associated with one display at a time
object	Tag [get, set]
	Field for user-definable data to be associated with the overlay object.
bool	InvokeRequired [get]
	tell whether actions on the display object require an invoke action or not (being user interface objects, display objects should not be modified asynchronously)
string	Text [get, set]
	Text being displayed on the label and/or in the status line
virtual System.Drawing.Color	Color [get, set]
	Color of the label
bool	IsDragable [get, set]
	Label dragable?

Additional Inherited Members
Protected Attributes inherited from OverlayBase
System.Drawing.Color	color_ = System.Drawing.Color.White
	Internally stored color.

Detailed Description

Display Label.

Constructor & Destructor Documentation

DisplayLabel() [1/3]

DisplayLabel	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		Point	pos
	)

Construct a display label.

Parameters

text	label text
canDrag	If true, the label becomes dragable, if false it will remain fixed
color	label color
pos	label position in pixel coordinates

DisplayLabel() [2/3]

DisplayLabel	(	string	text,
		bool	canDrag,
		System.Drawing.Color	color,
		Point	pos,
		object	tag
	)

Construct a display label.

Parameters

text	label text
canDrag	If true, the label becomes dragable, if false it will remain fixed
color	label color
pos	label position in pixel coordinates
tag	object with which this label is to be associated

DisplayLabel() [3/3]

DisplayLabel

(

DisplayLabel

obj

)

Copy constructor.

Parameters

obj	DisplayLabel object to copy.

Member Function Documentation

Overlay_ConnectedToDisplay()

override void Overlay_ConnectedToDisplay ( )

protectedvirtual

Add a label to a display.

Exceptions

ObjectDisposedException

If the display we are trying to work on has already been disposed

Implements OverlayBase.

Overlay_DisconnectedFromDisplay()

override void Overlay_DisconnectedFromDisplay ( bool  handBackID )

protectedvirtual

Remove a label from its display

Parameters

handBackID

true if the overlay ID should be handed back to the display, false otherwise.

Exceptions

ObjectDisposedException

If the display we are trying to work on has already been disposed

Implements OverlayBase.