WPF

Upgrade Guide User Guide Demos Support Forums Download
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class ScrollViewer - WPF API Reference | Syncfusion SfDiagram control ">

    Show / Hide Table of Contents

    Class ScrollViewer

    Represents the class which contains the data and functionalities of scroll viewer which uses to hold the entire SfDiagram control

    Inheritance
    System.Object
    ScrollViewer
    Implements
    System.ComponentModel.INotifyPropertyChanged
    IScrollInfo
    Namespace: Syncfusion.UI.Xaml.Diagram.Controls
    Assembly: Syncfusion.SfDiagram.WPF.dll
    Syntax
    public sealed class ScrollViewer : ContentControl, INotifyPropertyChanged, IInternalScrollInfo, IScrollInfo

    Constructors

    ScrollViewer()

    Initializes a new instance of the ScrollViewer class.

    Declaration
    public ScrollViewer()

    Fields

    ComputedHorizontalScrollBarVisibilityProperty

    Provides information about the ComputedHorizontalScrollBarVisibility property.

    Declaration
    public static DependencyProperty ComputedHorizontalScrollBarVisibilityProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ComputedVerticalScrollBarVisibilityProperty

    Provides information about the ComputedVerticalScrollBarVisibility property.

    Declaration
    public static DependencyProperty ComputedVerticalScrollBarVisibilityProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    CurrentZoomProperty

    Provides information about the CurrentZoom property.

    Declaration
    public static DependencyProperty CurrentZoomProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    HorizontalOffsetProperty

    Provides information about the ComputedVerticalScrollBarVisibility property.

    Declaration
    public static DependencyProperty HorizontalOffsetProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MaximumXProperty

    Provides information about the MaximumX property.

    Declaration
    public static DependencyProperty MaximumXProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MaximumYProperty

    Provides information about the MaximumY property.

    Declaration
    public static DependencyProperty MaximumYProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MaxZoomProperty

    Provides information about the MaxZoom property.

    Declaration
    public static DependencyProperty MaxZoomProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MinimumXProperty

    Provides information about the MinimumX property.

    Declaration
    public static DependencyProperty MinimumXProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MinimumYProperty

    Provides information about the MinimumY property.

    Declaration
    public static DependencyProperty MinimumYProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    MinZoomProperty

    Provides information about the MinZoom property.

    Declaration
    public static DependencyProperty MinZoomProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    PageProperty

    Provides information about the Page property.

    Declaration
    public static DependencyProperty PageProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ScrollFactorProperty

    Provides information about the ScrollFactor property.

    Declaration
    public static DependencyProperty ScrollFactorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    VerticalOffsetProperty

    Provides information about the VerticalOffset property.

    Declaration
    public static DependencyProperty VerticalOffsetProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ViewportHeightProperty

    Provides information about the ViewportHeight property.

    Declaration
    public static DependencyProperty ViewportHeightProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ViewportWidthProperty

    Provides information about the ViewportWidth property.

    Declaration
    public static DependencyProperty ViewportWidthProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ZoomFactorProperty

    Provides information about the ZoomFactor property.

    Declaration
    public static DependencyProperty ZoomFactorProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    ZoomPanTransformProperty

    Provides information about the ZoomPanTransform property.

    Declaration
    public static DependencyProperty ZoomPanTransformProperty
    Field Value
    Type Description
    System.Windows.DependencyProperty

    Properties

    Bottom

    Gets the y-axis value of the bottom of the scroll viewer.

    Declaration
    public double Bottom { get; }
    Property Value
    Type Description
    System.Double

    Bounds

    Gets the bounds value of the diagram control.

    Declaration
    public Rect Bounds { get; }
    Property Value
    Type Description
    System.Windows.Rect

    ComputedHorizontalScrollBarVisibility

    Gets the visibility value of the horizontal scroll bar.

    Declaration
    public Visibility ComputedHorizontalScrollBarVisibility { get; }
    Property Value
    Type Description
    System.Windows.Visibility

    ComputedVerticalScrollBarVisibility

    Gets the visibility value of the vertical scroll bar.

    Declaration
    public Visibility ComputedVerticalScrollBarVisibility { get; }
    Property Value
    Type Description
    System.Windows.Visibility

    CurrentZoom

    Gets or sets the zooming level value of diagram control.

    Declaration
    public double CurrentZoom { get; set; }
    Property Value
    Type Description
    System.Double

    HorizontalOffset

    Gets a value that contains the horizontal offset of the diagram control.

    Declaration
    public double HorizontalOffset { get; }
    Property Value
    Type Description
    System.Double

    Left

    Gets the x-axis value of the left side of the diagram control.

    Declaration
    public double Left { get; }
    Property Value
    Type Description
    System.Double

    MaximumX

    Gets the x-axis value of the right side of the diagram control.

    Declaration
    public double MaximumX { get; }
    Property Value
    Type Description
    System.Double

    MaximumY

    Gets the y-axis value of the bottom side of the diagram control.

    Declaration
    public double MaximumY { get; }
    Property Value
    Type Description
    System.Double

    MaxZoom

    Gets or sets the maximum zoom value of the diagram control.

    Declaration
    public double MaxZoom { get; set; }
    Property Value
    Type Description
    System.Double

    MinimumX

    Gets or sets the x-axis value of the left side of the diagram control.

    Declaration
    public double MinimumX { get; set; }
    Property Value
    Type Description
    System.Double

    MinimumY

    Gets or sets the y-axis value of the right side of the diagram control.

    Declaration
    public double MinimumY { get; set; }
    Property Value
    Type Description
    System.Double

    MinZoom

    Gets or sets the minimum zooming value of the diagram control.

    Declaration
    public double MinZoom { get; set; }
    Property Value
    Type Description
    System.Double

    Page

    Gets or sets the panel value of the diagram control which uses to hold diagram elements of Node , Connector and Group.

    Declaration
    public Panel Page { get; set; }
    Property Value
    Type Description
    System.Windows.Controls.Panel

    Right

    Gets the x-axis value of the right side of the diagram control

    Declaration
    public double Right { get; }
    Property Value
    Type Description
    System.Double

    ScrollFactor

    Gets or sets the current scroll level of the scrolling activity of diagram control.

    Declaration
    public double? ScrollFactor { get; set; }
    Property Value
    Type Description
    System.Nullable<System.Double>

    Top

    Gets the y-axis value of the top side of the diagram control.

    Declaration
    public double Top { get; }
    Property Value
    Type Description
    System.Double

    VerticalOffset

    Gets the vertical distance between the target origin and the diagram control alignment point.

    Declaration
    public double VerticalOffset { get; }
    Property Value
    Type Description
    System.Double

    Viewport

    Gets the position and dimensions of the base tile for a diagram control.

    Declaration
    public Rect Viewport { get; }
    Property Value
    Type Description
    System.Windows.Rect

    ViewportHeight

    Gets a value that contains the vertical size of the diagram control's viewport.

    Declaration
    public double ViewportHeight { get; }
    Property Value
    Type Description
    System.Double

    ViewportWidth

    Gets a value that contains the horizontal size of the diagram control's viewport.

    Declaration
    public double ViewportWidth { get; }
    Property Value
    Type Description
    System.Double

    ZoomFactor

    Gets or sets the current zoom level of the diagram control.

    Declaration
    public double ZoomFactor { get; set; }
    Property Value
    Type Description
    System.Double

    ZoomPanTransform

    Gets or sets the composite transform values of the diagram control while Zooming and Panning operations of diagram page.

    Declaration
    public TransformGroup ZoomPanTransform { get; set; }
    Property Value
    Type Description
    System.Windows.Media.TransformGroup

    Methods

    ArrangeOverride(Size)

    Arranges the content of the diagram control.

    Declaration
    protected override Size ArrangeOverride(Size finalSize)
    Parameters
    Type Name Description
    System.Windows.Size finalSize

    The final area within the parent that diagram elements should use to arrange itself and its children.

    Returns
    Type Description
    System.Windows.Size

    The size of the diagram control.

    BringIntoCenter(Rect)

    To bring the specified bounds of diagram control into center of the view.

    Declaration
    public void BringIntoCenter(Rect bounds)
    Parameters
    Type Name Description
    System.Windows.Rect bounds

    The bounds value which should be shown at center of the view.

    BringIntoViewport(Rect)

    To bring the specified bounds of diagram control into view.

    Declaration
    public void BringIntoViewport(Rect bounds)
    Parameters
    Type Name Description
    System.Windows.Rect bounds

    The bounds value which should be shown into view.

    MeasureOverride(Size)

    Measures the content of a diagram elements.

    Declaration
    protected override Size MeasureOverride(Size availableSize)
    Parameters
    Type Name Description
    System.Windows.Size availableSize

    The upper limit size that should not be exceeded.

    Returns
    Type Description
    System.Windows.Size

    The computed desired limit size of the diagram elements.

    OnApplyTemplate()

    Called when an internal process or application calls System.Windows.FrameworkElement.ApplyTemplate which is used to build the current template's visual tree.

    Declaration
    public override void OnApplyTemplate()

    Pan(Point)

    Pans the diagram page by specified value.

    Declaration
    public void Pan(Point delta)
    Parameters
    Type Name Description
    System.Windows.Point delta

    The point value that how much the diagram page should be pan.

    PanTo(Point)

    Pans the diagram page to specified position.

    Declaration
    public void PanTo(Point position)
    Parameters
    Type Name Description
    System.Windows.Point position

    The point value where the entire diagram page should be pan.

    Reset()

    Clears all the panning opertions and removes all the panning relations of diagam control. Restores the panning position to origin of the diagram control by zoom level of One.

    Declaration
    public void Reset()

    ResetPan()

    Clears all the panning opertions and removes all the panning relations of diagam control. Restores the panning position to origin of the diagram control by zoom level of CurrentZoom value.

    Declaration
    public void ResetPan()

    ResetZoom()

    Clears all the zooming opertions and removes all the zooming relations of diagam control. Restores the diagram control page by zoom level of One.

    Declaration
    public void ResetZoom()

    SetPageBackground(Object, String)

    Sets the background color, border thickness, and border color of the page of the diagram control.

    Declaration
    public void SetPageBackground(object value, string property)
    Parameters
    Type Name Description
    System.Object value

    The value for background color, border thickness or borde color.

    System.String property

    The property value of the page.

    ZoomIn(IZoomParameter)

    To zoom in on the surface of the page of the diagram control.

    Declaration
    public void ZoomIn(IZoomParameter param)
    Parameters
    Type Name Description
    IZoomParameter param

    A IZoomParameter value to perfom zoom in.

    ZoomOut(IZoomParameter)

    To zoom out on the surface of the page of the diagram control.

    Declaration
    public void ZoomOut(IZoomParameter param)
    Parameters
    Type Name Description
    IZoomParameter param

    A IZoomParameter value to perfom zoom out.

    ZoomPan(IZoomParameter)

    To perform zooming and panning opertions to the diagram control.

    Declaration
    public void ZoomPan(IZoomParameter param)
    Parameters
    Type Name Description
    IZoomParameter param

    A IZoomParameter value to perfom zooming and panning.

    Events

    PropertyChanged

    Occurs when changes are detected to the diagram control's properties.

    Declaration
    public event PropertyChangedEventHandler PropertyChanged
    Event Type
    Type Description
    System.ComponentModel.PropertyChangedEventHandler

    Implements

    System.ComponentModel.INotifyPropertyChanged
    IScrollInfo
    Back to top Generated by DocFX
    Copyright © 2001 - 2021 Syncfusion Inc. All Rights Reserved