ControlOverlay Class Reference

Display overlay placed on the display canvas. More...

Inherits OverlayBase.

Additional Inherited Members
Public Member Functions inherited from OverlayBase
	OverlayBase ()
	Creates an overlay object.
Static Public Attributes inherited from OverlayBase
static readonly DependencyProperty	ActualZoomFactorProperty = ActualZoomFactorKey.DependencyProperty
	Backing store for the ActualZoomFactor property.
static readonly DependencyProperty	InverseActualZoomFactorProperty = InverseActualZoomFactorPropertyKey.DependencyProperty
	Backing store.
static readonly DependencyProperty	OverlayHeightProperty
	Backing store for the OverlayHeight property.
static readonly DependencyProperty	OverlayWidthProperty
	Backing store for the OverlayWidth property.
static readonly DependencyProperty	OverlayXProperty
	Backing store for the OverlayX property.
static readonly DependencyProperty	OverlayYProperty
	Backing store for the OverlayY property.
static readonly DependencyProperty	ParentDisplayCanvasProperty
	Backing store for the readonly ParentDisplayCanvas property.
static readonly DependencyProperty	BottomProperty
	Backing store for the Bottom property.
static readonly DependencyProperty	LeftProperty
	Backing store for the Left property.
static readonly DependencyProperty	LengthUnitProperty
	Backing store for the LengthUnit property.
static readonly DependencyProperty	RightProperty
	Backing store for the Right property.
static readonly DependencyProperty	TopProperty
	Backing store for the Top property.
Protected Member Functions inherited from OverlayBase
virtual void	OnParentDisplayCanvasChanged (DisplayCanvas oldCanvas, DisplayCanvas newCanvas)
	Event raiser.
Static Protected Member Functions inherited from OverlayBase
static void	OnActualZoomFactorChanged (DependencyObject d, DependencyPropertyChangedEventArgs e)
	React to property changes.
Static Protected Attributes inherited from OverlayBase
static readonly DependencyPropertyKey	ActualZoomFactorKey
	The Key for readonly ActualZoomFactor property.
static readonly DependencyPropertyKey	InverseActualZoomFactorPropertyKey
	Backing store key.
Properties inherited from OverlayBase
double	ActualZoomFactor [get]
	Gets the actual zoom factor of the display canvas this overlay is on.
double	InverseActualZoomFactor [get, protected set]
	Gets the inverse value of the actual Zoom factor (useful for painting items that are the same size regardless of zoom factor).
double	OverlayHeight [get, set]
	Gets/sets the height of the overlay in the current length unit.
double	OverlayWidth [get, set]
	Gets/sets the width of the overlay in the current length unit.
double	OverlayX [get, set]
	Gets/sets the overlay x coordinate in the current length unit.
double	OverlayY [get, set]
	Gets/set the overlay Y in the current length unit.
DisplayCanvas	ParentDisplayCanvas [get, set]
	The DisplayCanvas this overlay is child of.
double	Bottom [get, set]
	Layouts a child from the bottom.
double	Left [get, set]
	Layouts a child from the left.
LengthUnit	LengthUnit [get]
	Defines whether the layout properties are measured in image pixels or in device independent pixels as displayed by the canvas.
double	Right [get, set]
	Layouts a child from the right.
double	Top [get, set]
	Layouts a child from the top.
Events inherited from OverlayBase
EventHandler< PropertyValueChangedEventArgs< DisplayCanvas > >	ParentDisplayCanvasChanged
	Event that is fired when the parent DisplayCanvas is changed.
EventHandler< DisplayZoomEventArgs >	ActualZoomFactorChanged
	Event that is fired when the parent DisplayCanvas' actual zoom factor is changed.

Detailed Description

Display overlay placed on the display canvas.

These overlays are always placed in control coordinates like on a canvas and are not moved/scaled based on the displayed image.