ZoomContentControl Class

[TemplatePart(Name = "PART_Canvas", Type = typeof(Canvas))]
[TemplatePart(Name = "PART_PanPad", Type = typeof(PanPad))]
[TemplatePart(Name = "PART_ViewControlPane", Type = typeof(FrameworkElement))]
[TemplatePart(Name = "PART_ZoomDecorator", Type = typeof(ZoomDecorator))]
public class ZoomContentControl : ContentControl, ILogicalParent

public ZoomContentControl()

public bool AreDefaultInputBindingsEnabled { get; set; }

Property Value

bool:

true if the default input bindings are automatically added; otherwise false. The default value is true.

public bool AreOverlaysVisible { get; set; }

Property Value

bool:

true if the overlays are visible; otherwise false. The default value is true.

public bool AreZoomButtonsVisible { get; set; }

Property Value

bool:

true if the zoom buttons are visible on the view control pane; otherwise false. The default value is true.

public static ResourceKey ButtonBaseStyleKey { get; }

Property Value

ResourceKey:

A resource key.

public Canvas Canvas { get; }

Property Value

Canvas

public Point? CenterPoint { get; set; }

Property Value

Point?:

The current center point of the view. The default value is null.

public Point? CenterPointResolved { get; }

Property Value

Point?:

The resolved center point of the view. The default value is null.

Remarks

This value can differ from CenterPoint when virtual space is disabled and the center point is coerced.

public Size ChildSize { get; }

Property Value

Size:

The size of the child element. The default value is 0,0.

public Point? DefaultCenterPoint { get; set; }

Property Value

Point?:

The default center point of the view. The default value is null.

public double DefaultZoomLevel { get; set; }

Property Value

double:

The default zoom level. The default value is 1.0.

public bool HasHorizontalItems { get; }

Property Value

bool:

true if HorizontalItems has one or more items; otherwise false. The default value is false.

public LogicalChildrenCollection<UIElement> HorizontalItems { get; }

Property Value

LogicalChildrenCollection<UIElement>:

The additional items displayed in the top row of the view control pane.

public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

A ScrollBarVisibility value that indicates whether a horizontal ScrollBar should be displayed. The default value is ScrollBarVisibility.Visible.

public Unit HorizontalScrollLineStep { get; set; }

Property Value

Unit:

The value used when incrementing and decrementing the horizontal offset by a line. The default value is 1 pixel.

public Unit HorizontalScrollPageStep { get; set; }

Property Value

Unit:

The value used when incrementing and decrementing the horizontal offset by a page. The default value is 100 percent of the viewport.

public static ResourceKey HorizontalSeparatorStyleKey { get; }

Property Value

ResourceKey:

A resource key.

public bool IsPanPadVisible { get; set; }

Property Value

bool:

true if the pan pad is visible in the view control pane; otherwise false. The default value is true.

public bool IsResetViewButtonVisible { get; set; }

Property Value

bool:

true if the reset view button is visible in the view control pane; otherwise false. The default value is true.

public bool IsViewControlPaneMinimizable { get; set; }

Property Value

bool:

true if the view control pane is minimizable; otherwise false. The default value is true.

public bool IsViewControlPaneMinimized { get; set; }

Property Value

bool:

true if the view control pane is minimized; otherwise false. The default value is false.

public bool IsViewControlPaneVisible { get; set; }

Property Value

bool:

true if the view control pane is visible; otherwise false. The default value is true.

public bool IsVirtualSpaceEnabled { get; set; }

Property Value

bool:

true if virtual space is enabled, which allows all parts of the content to be centered in the view; otherwise false. The default value is false.

public bool IsZoomLabelVisible { get; set; }

Property Value

bool:

true if the zoom label is visible in the view control pane; otherwise false. The default value is true.

public bool IsZoomSliderVisible { get; set; }

Property Value

bool:

true if the zoom slider is visible in the view control pane; otherwise false. The default value is true.

public bool IsZoomToFitButtonVisible { get; set; }

Property Value

bool:

true if the zoom-to-fit button is visible in the view control pane; otherwise false. The default value is true.

protected override IEnumerator LogicalChildren { get; }

Property Value

IEnumerator

public double MaxZoomLevel { get; set; }

Property Value

double:

A percentage value indicating the maximum zoom level of the content. The default value is 10.0.

public double MinZoomLevel { get; set; }

Property Value

double:

A percentage value indicating the minimum zoom level of the content. The default value is 0.1.

public LogicalChildrenCollection<UIElement> Overlays { get; }

Property Value

LogicalChildrenCollection<UIElement>:

The additional items overlaid on top of the content.

public Duration PanAnimationDuration { get; set; }

Property Value

Duration:

The Duration to animate the panning from one location to the next. The default value is 200ms.

Remarks

Set to 0ms or Duration.Automatic to disable pan animation.

See Also

• ZoomLevel

public static ResourceKey PopupButtonStyleKey { get; }

Property Value

ResourceKey:

A resource key.

public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }

Property Value

ScrollBarVisibility:

A ScrollBarVisibility value that indicates whether a vertical ScrollBar should be displayed. The default value is ScrollBarVisibility.Visible.

public Unit VerticalScrollLineStep { get; set; }

Property Value

Unit:

The value used when incrementing and decrementing the vertical offset by a line. The default value is 1 pixel.

public Unit VerticalScrollPageStep { get; set; }

Property Value

Unit:

The value used when incrementing and decrementing the vertical offset by a page. The default value is 100 percent of the viewport.

public static ResourceKey VerticalSeparatorStyleKey { get; }

Property Value

ResourceKey:

A resource key.

public double ViewControlPaneOpacityAnimated { get; set; }

Property Value

double:

The current opacity of the view control pane background as it animates between ViewControlPaneOpacityHover and ViewControlPaneOpacityNormal. The default value is 1.0.

Remarks

This property is used by the ZoomContentControl to animate the opacity of the view control pane and should not be explicitly set.

public double ViewControlPaneOpacityHover { get; set; }

Property Value

double:

The opacity of the view control pane background when the mouse is hovering. The default value is 1.0.

public double ViewControlPaneOpacityNormal { get; set; }

Property Value

double:

The opacity of the view control pane background when the mouse is not hovering. The default value is 1.0.

public Size ViewportSize { get; }

Property Value

Size:

The size of the viewport. The default value is 0,0.

public Duration ZoomAnimationDuration { get; set; }

Property Value

Duration:

The Duration to animate the scale from one zoom level to the next. The default value is 300ms.

Remarks

Set to 0ms or Duration.Automatic to disable zoom animation.

See Also

• ZoomLevel

public double ZoomLevel { get; set; }

Property Value

double:

A percentage value indicating the current zoom level of the content.. The default value is double.NaN, which indicates that DefaultZoomLevel will be used.

public DoubleCollection ZoomLevelStops { get; set; }

Property Value

DoubleCollection:

The possible zoom level stops when zooming in or out incrementally. The default value is null, which indicates that ZoomStep should be used.

public double ZoomStep { get; set; }

Property Value

double:

The value used when incrementing and decrementing the zoom level. The default value is 0.1.

public void BeginUpdate()

public void CenterAndZoomInToPoint(Point? point)

Parameter	Type	Description
point	Point?	The point to center; otherwise null to use the current mouse position.

public void CenterAndZoomOutFromPoint(Point? point)

Parameter	Type	Description
point	Point?	The point to center; otherwise null to use the current mouse position.

public void CenterToPoint(Point? point)

Parameter	Type	Description
point	Point?	The point to center; otherwise null to use the current mouse position.

public void CenterView()

public void CenterView(Orientation orientation)

Parameter	Type	Description
orientation	Orientation	The orientation that should be centered.

public void EndUpdate()

public void EndUpdate(bool animate)

Parameter	Type	Description
animate	bool	if set to true then any changes can be animated.

public void LineDown()

public void LineDown(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the line step by.

public void LineLeft()

public void LineLeft(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the line step by.

public void LineRight()

public void LineRight(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the line step by.

public void LineUp()

public void LineUp(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the line step by.

public override void OnApplyTemplate()

protected override AutomationPeer OnCreateAutomationPeer()

Returns

AutomationPeer:

The type-specific AutomationPeer implementation.

protected override void OnIsKeyboardFocusWithinChanged(DependencyPropertyChangedEventArgs e)

Parameter	Type	Description
e	DependencyPropertyChangedEventArgs	A System.Windows.DependencyPropertyChangedEventArgs that contains the event data.

protected override void OnLostMouseCapture(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains event data.

protected override void OnMouseEnter(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains the event data.

protected override void OnMouseLeave(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains the event data.

protected override void OnMouseMove(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	The MouseEventArgs that contains the event data.

protected override void OnMouseUp(MouseButtonEventArgs e)

Parameter	Type	Description
e	MouseButtonEventArgs	The MouseButtonEventArgs that contains the event data. The event data reports that the mouse button was released.

protected override void OnPreviewKeyDown(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected override void OnPreviewKeyUp(KeyEventArgs e)

Parameter	Type	Description
e	KeyEventArgs	The KeyEventArgs that contains the event data.

protected virtual void OnZoomLevelChanged(RoutedEventArgs e)

Parameter	Type	Description
e	RoutedEventArgs	The RoutedEventArgs that contains the event data.

Remarks

This method has no default implementation. Because an intermediate class in the inheritance might implement this method, we recommend that you call the base implementation in your implementation.

public void PageDown()

public void PageDown(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the page step by.

public void PageLeft()

public void PageLeft(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the page step by.

public void PageRight()

public void PageRight(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the page step by.

public void PageUp()

public void PageUp(double factor)

Parameter	Type	Description
factor	double	The factor to multiply the page step by.

public void Pan(double xOffset, double yOffset)

Parameter	Type	Description
xOffset	double	The offset to pan along the X-axis.
yOffset	double	The offset to pan along the Y-axis.

public void ResetView()

public void StartPanDrag()

Remarks

The left, right, or middle mouse button must be pressed when this method is called. Once the operation is started, the end-user can pan the content until the mouse button is released.

Exceptions

Type	Condition
InvalidOperationException	Neither the left, the right, or the middle mouse button is down.

public void StartZoomDrag()

Remarks

The left, right, or middle mouse button must be pressed when this method is called. Once the operation is started, the end-user can zoom the content until the mouse button is released.

Exceptions

Type	Condition
InvalidOperationException	Neither the left, the right, or the middle mouse button is down.

public void StartZoomIn()

Remarks

The left, right, or middle mouse button must be pressed when this method is called. Once the operation is started, the end-user can continuously zoom-in the content until the mouse button is released.

Exceptions

Type	Condition
InvalidOperationException	Neither the left, the right, or the middle mouse button is down.

public void StartZoomOut()

Remarks

The left, right, or middle mouse button must be pressed when this method is called. Once the operation is started, the end-user can continuously zoom-out the content until the mouse button is released.

Exceptions

Type	Condition
InvalidOperationException	Neither the left, the right, or the middle mouse button is down.

public void StartZoomToRegion()

Remarks

The left, right, or middle mouse button must be pressed when this method is called. Once the operation is started, the end-user can draw a rectangle over the content until the mouse button is released.

Exceptions

Type	Condition
InvalidOperationException	Neither the left, the right, or the middle mouse button is down.

public Point TranslatePointFromContent(Point point)

Parameter	Type	Description
point	Point	The point.

Returns

Point:

A point value, now relative to this element rather than the content element.

public Point TranslatePointToContent(Point point)

Parameter	Type	Description
point	Point	The point.

Returns

Point:

A point value, now relative to the content element rather than this element.

public virtual void UpdateCursor()

public void ZoomIn()

public void ZoomInToPoint(Point? point)

Parameter	Type	Description
point	Point?	The point to anchor; otherwise null to use the current mouse position.

public void ZoomOut()

public void ZoomOutFromPoint(Point? point)

Parameter	Type	Description
point	Point?	The point to anchor; otherwise null to use the current mouse position.

public void ZoomToFit()

public void ZoomToFit(bool centerView)

Parameter	Type	Description
centerView	bool	if set to true the view will be centered.

public void ZoomToFit(Orientation orientation)

Parameter	Type	Description
orientation	Orientation	The orientation that should be fitted.

public void ZoomToFit(Orientation orientation, bool centerView)

Parameter	Type	Description
orientation	Orientation	The orientation that should be fitted.
centerView	bool	if set to true the view will be centered.

public event RoutedEventHandler ZoomLevelChanged

Event Type

RoutedEventHandler

public static readonly DependencyProperty AreDefaultInputBindingsEnabledProperty

public static readonly DependencyProperty AreOverlaysVisibleProperty

public static readonly DependencyProperty AreZoomButtonsVisibleProperty

public static readonly DependencyProperty CenterPointProperty

public static readonly DependencyProperty CenterPointResolvedProperty

public static readonly DependencyProperty ChildSizeProperty

public static readonly DependencyProperty DefaultCenterPointProperty

public static readonly DependencyProperty DefaultZoomLevelProperty

public static readonly DependencyProperty HasHorizontalItemsProperty

public static readonly DependencyProperty HorizontalScrollBarVisibilityProperty

public static readonly DependencyProperty HorizontalScrollLineStepProperty

public static readonly DependencyProperty HorizontalScrollPageStepProperty

public static readonly DependencyProperty IsPanPadVisibleProperty

public static readonly DependencyProperty IsResetViewButtonVisibleProperty

public static readonly DependencyProperty IsViewControlPaneMinimizableProperty

public static readonly DependencyProperty IsViewControlPaneMinimizedProperty

public static readonly DependencyProperty IsViewControlPaneVisibleProperty

public static readonly DependencyProperty IsVirtualSpaceEnabledProperty

public static readonly DependencyProperty IsZoomLabelVisibleProperty

public static readonly DependencyProperty IsZoomSliderVisibleProperty

public static readonly DependencyProperty IsZoomToFitButtonVisibleProperty

public static readonly DependencyProperty MaxZoomLevelProperty

public static readonly DependencyProperty MinZoomLevelProperty

public static readonly DependencyProperty PanAnimationDurationProperty

public static readonly DependencyProperty VerticalScrollBarVisibilityProperty

public static readonly DependencyProperty VerticalScrollLineStepProperty

public static readonly DependencyProperty VerticalScrollPageStepProperty

public static readonly DependencyProperty ViewControlPaneOpacityAnimatedProperty

public static readonly DependencyProperty ViewControlPaneOpacityHoverProperty

public static readonly DependencyProperty ViewControlPaneOpacityNormalProperty

public static readonly DependencyProperty ViewportSizeProperty

public static readonly DependencyProperty ZoomAnimationDurationProperty

public static readonly RoutedEvent ZoomLevelChangedEvent

public static readonly DependencyProperty ZoomLevelProperty

public static readonly DependencyProperty ZoomLevelStopsProperty

public static readonly DependencyProperty ZoomStepProperty