menu

WPF

  • Code Examples
  • Upgrade Guide
  • User Guide
  • Demos
  • Support
  • Forums
  • Download
Class TreeGridAutoScroller - WPF API Reference | Syncfusion

    Show / Hide Table of Contents

    Class TreeGridAutoScroller

    Represents a class that provides base implementation for automatic scrolling of content in SfTreeGrid.

    Inheritance
    System.Object
    TreeGridAutoScroller
    Implements
    System.IDisposable
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ReferenceEquals(System.Object, System.Object)
    System.Object.ToString()
    Namespace: Syncfusion.UI.Xaml.TreeGrid
    Assembly: Syncfusion.SfGrid.WPF.dll
    Syntax
    public class TreeGridAutoScroller : IDisposable

    Constructors

    TreeGridAutoScroller()

    Initializes a new instance of the TreeGridAutoScroller class.

    Declaration
    public TreeGridAutoScroller()

    Properties

    AutoScrollBounds

    Gets or sets the display rectangle of outer scroll area. Typically the client area of the control.

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

    The that contains the rectangle information about the outer scroll area.

    AutoScrolling

    Gets or sets the orientation of auto-scrolling.

    Declaration
    public AutoScrollOrientation AutoScrolling { get; set; }
    Property Value
    Type Description
    AutoScrollOrientation

    One of the AutoScrollOrientation that specifies the orientation of auto-scrolling.

    HScrollBar

    Gets the horizontal scrollbar value of TreeGridPanel .

    Declaration
    public IScrollBar HScrollBar { get; }
    Property Value
    Type
    IScrollBar

    InsideScrollBounds

    Gets the display rectangle of inside scroll area. The control will scroll if the user drag the mouse outside of TreeGridPanel area.

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

    The that contains the rectangle information of inside scroll area.

    InsideScrollMargin

    Gets or Sets the default margin for the scrolling area when the user moves the mouse point to the margin between InsideScrollBounds and AutoScrollBounds.

    Declaration
    public Size InsideScrollMargin { get; set; }
    Property Value
    Type
    System.Windows.Size

    IntervalTime

    Gets or sets the timer interval for auto scrolling.

    Declaration
    public TimeSpan IntervalTime { get; set; }
    Property Value
    Type
    System.TimeSpan

    IsEnabled

    Gets or sets a value that indicates whether the auto-scrolling is enabled in SfTreeGrid.

    Declaration
    public bool IsEnabled { get; set; }
    Property Value
    Type Description
    System.Boolean

    true if the auto-scrolling is enabled; otherwise, false.

    MouseMovePosition

    Gets or sets the mouse position during move operation performed in TreeGridPanel.

    Declaration
    protected Point MouseMovePosition { get; set; }
    Property Value
    Type Description
    System.Windows.Point

    The that specifies the corresponding mouse move position.

    TreeGridPanel

    Gets or sets the reference to the TreeGridPanel .

    Declaration
    public TreeGridPanel TreeGridPanel { get; set; }
    Property Value
    Type
    TreeGridPanel

    VScrollBar

    Gets the vertical scrollbar value of TreeGridPanel .

    Declaration
    public IScrollBar VScrollBar { get; }
    Property Value
    Type
    IScrollBar

    Methods

    AutoScroll(Point)

    Scrolls automatically for the specified mouse point.

    Declaration
    protected virtual void AutoScroll(Point mousePoint)
    Parameters
    Type Name Description
    System.Windows.Point mousePoint

    The mouse point to scroll automatically.

    Dispose()

    Disposes all the resources used by the TreeGridAutoScroller class.

    Declaration
    public void Dispose()

    Dispose(Boolean)

    Disposes all the resources used by the TreeGridAutoScroller class.

    Declaration
    protected virtual void Dispose(bool disposing)
    Parameters
    Type Name Description
    System.Boolean disposing

    true to release all the resources.

    OnAutoScrollingChanged(EventArgs)

    Raises the AutoScrollingChanged event.

    Declaration
    protected virtual void OnAutoScrollingChanged(EventArgs e)
    Parameters
    Type Name Description
    System.EventArgs e

    An System.EventArgs that contains the event data.

    RaiseAutoScrollerValueChanged(Boolean, Boolean, Boolean, Boolean, RowColumnIndex)

    Raises the AutoScrollerValueChanged event.

    Declaration
    protected virtual void RaiseAutoScrollerValueChanged(bool isLineUp, bool isLineDown, bool isLineLeft, bool isLineRight, RowColumnIndex rowColumnIndex)
    Parameters
    Type Name Description
    System.Boolean isLineUp

    Indicates whether the content is scrolled upward to the SfTreeGrid during drag selection.

    System.Boolean isLineDown

    Indicates whether the content is scrolled downward to the SfTreeGrid during drag selection.

    System.Boolean isLineLeft

    Indicates whether the content is scrolled left to the SfTreeGrid during drag selection.

    System.Boolean isLineRight

    Indicates whether the content is scrolled right to the SfTreeGrid during drag selection.

    RowColumnIndex rowColumnIndex

    The corresponding scroll row column index while performing dragging in SfTreeGrid.

    ResetInsideScrollMargins()

    Resets the InsideScrollMargin property to its default value.

    Declaration
    public void ResetInsideScrollMargins()

    Events

    AutoScrollerValueChanged

    Occurs when the drag selection is performed .

    Declaration
    public event EventHandler<AutoScrollerValueChangedEventArgs> AutoScrollerValueChanged
    Event Type
    Type
    System.EventHandler<AutoScrollerValueChangedEventArgs>
    Remarks

    Drag selection is enabled when the is Multiple or Extended.

    AutoScrollingChanged

    Occurs when the auto-scrolling is being performed in SfTreeGrid..

    Declaration
    public event EventHandler AutoScrollingChanged
    Event Type
    Type
    System.EventHandler
    Remarks

    If you want to prevent auto-scrolling, handle this event and reset the AutoScrolling property.

    Implements

    System.IDisposable
    Back to top Generated by DocFX
    Copyright © 2001 - 2025 Syncfusion Inc. All Rights Reserved