Click or drag to resize

ViewportCanvas Class

A canvas that transforms the coordinates of it's children to the own visual before arranging them. It is used to have an overlay of non-scaled object on top of a scaled object, where the coordinates of the overlay objects are expressed in the coordinate system of the scaled object (World). One major use case are e.g. pin points on a map, where the map scales, while the pin points only move but keep their size. While the Canvas only accepts one of Left/Right or Top/Bottom, with the ViewportCanvas you can specify both to stretch the object accordingly to the transformation.
Inheritance Hierarchy

Namespace:  TomsToolbox.Wpf.Controls
Assembly:  TomsToolbox.Wpf (in TomsToolbox.Wpf.dll) Version: 1.0.70.0
Syntax
public class ViewportCanvas : Canvas

The ViewportCanvas type exposes the following members.

Constructors
  NameDescription
Public methodViewportCanvas
Initializes a new instance of the ViewportCanvas class
Top
Properties
  NameDescription
Public propertyWorld
Gets or sets the physical layer. The children's coordinates are assumed to be relative to the physical layer.

[CanBeNull]

Top
Methods
  NameDescription
Protected methodArrangeOverride
When overridden in a derived class, positions child elements and determines a size for a FrameworkElement derived class.
(Overrides CanvasArrangeOverride(Size).)
Public methodInvalidate
Invalidates the layout of this instance.
Protected methodMeasureOverride
When overridden in a derived class, measures the size in layout required for child elements and determines a size for the FrameworkElement-derived class.
(Overrides CanvasMeasureOverride(Size).)
Top
Fields
  NameDescription
Public fieldStatic memberWorldProperty
Identifies the World dependency property.

[NotNull]

Top
Extension Methods
  NameDescription
Public Extension MethodAncestors
Returns an enumeration of the ancestor elements in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodAncestorsAndSelf
Returns an enumeration of elements that contain this element, and the ancestors in the logical tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodBeginInvoke(Action)Overloaded.
Invokes the specified method asynchronously in the dispatcher thread of the visual.

[NotNull]

(Defined by VisualExtensions.)
Public Extension MethodBeginInvoke(DispatcherPriority, Action)Overloaded.
Invokes the specified method asynchronously in the dispatcher thread of the visual.

[NotNull]

(Defined by VisualExtensions.)
Public Extension MethodGetClientRectOverloaded.
Gets the client rectangle of the framework element.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetClientRect(Visual)Overloaded.
Gets the client rectangle of the framework element translated to another visual.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetDesignUnitSize
Gets the physical size of one design unit in pixels.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetExportProvider
Gets the active export provider for the specified object.

[NotNull]

(Defined by ExportProviderLocator.)
Public Extension MethodGetExtentOverloaded.
Gets the extent of the framework element.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetExtent(FrameworkElement)Overloaded.
Gets the extent of the framework element translated to another visual.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetPhysicalPixelSize
Gets the physical size of one pixel in design units.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodGetRootVisual
Gets the root visual for the item.

[NotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodGetValueT (Defined by DependencyObjectExtensions.)
Public Extension MethodGetWindowHandle
Gets the window handle of the HwndSource hosting this item.
(Defined by DependencyObjectExtensions.)
Public Extension MethodProcessMessagesOverloaded.
Waits until all pending messages up to the Background priority are processed.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodProcessMessages(DispatcherPriority)Overloaded.
Waits until all pending messages up to the specified priority are processed.
(Defined by PresentationFrameworkExtensions.)
Public Extension MethodSafeCastT
Performs a cast from object to T, avoiding possible null violations if T is a value type.

[CanBeNull]

(Defined by ObjectExtensions.)
Public Extension MethodSetExportProvider
Sets the export provider.
(Defined by ExportProviderLocator.)
Public Extension MethodTryFindAncestorTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfTOverloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryFindAncestorOrSelfT(FuncT, Boolean)Overloaded.
Returns the first element in the ancestor list that implements the type of the type parameter.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodTryGetExportProvider
Gets the active export provider for the specified object, or null if no export provider is registered.

[CanBeNull]

(Defined by ExportProviderLocator.)
Public Extension MethodTryGetRootVisual
Gets the root visual for the item.

[CanBeNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestors
Returns an enumeration of the ancestor elements in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualAncestorsAndSelf
Returns an enumeration of elements that contains this element, and the ancestors in the visual tree of this element.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildren
Enumerates the immediate children of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualChildrenAndSelf
Enumerates the specified item and it's immediate children.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendants
Enumerates all visuals descendants of the specified item.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Public Extension MethodVisualDescendantsAndSelf
Enumerates the specified item and all it's visual descendants.

[NotNull, ItemNotNull]

(Defined by DependencyObjectExtensions.)
Top
See Also