Class GridViewScrollViewer

Represents a scrollable area that can contain other visible elements.

Inheritance
System.Object
GridViewScrollViewer
Namespace: Telerik.Windows.Controls.GridView
Assembly: Telerik.Windows.Controls.GridView.dll

Syntax

public class GridViewScrollViewer : ContentControl, IScrollViewerAdapter

Constructors

GridViewScrollViewer()

Initializes a new instance of the GridViewScrollViewer class.

Declaration
public GridViewScrollViewer()

Fields

CanContentScrollProperty

Identifies the CanContentScroll dependency property.

Declaration
public static readonly DependencyProperty CanContentScrollProperty
Field Value
System.Windows.DependencyProperty

ComputedHorizontalScrollBarVisibilityProperty

Identifies the ComputedHorizontalScrollBarVisibility dependency property.

Declaration
public static readonly DependencyProperty ComputedHorizontalScrollBarVisibilityProperty
Field Value
System.Windows.DependencyProperty

ComputedVerticalScrollBarVisibilityProperty

Identifies the ComputedVerticalScrollBarVisibility dependency property.

Declaration
public static readonly DependencyProperty ComputedVerticalScrollBarVisibilityProperty
Field Value
System.Windows.DependencyProperty

ContentHorizontalOffsetProperty

Identifies the ContentHorizontalOffset dependency property.

Declaration
public static readonly DependencyProperty ContentHorizontalOffsetProperty
Field Value
System.Windows.DependencyProperty

ContentVerticalOffsetProperty

Identifies the ContentVerticalOffset dependency property.

Declaration
public static readonly DependencyProperty ContentVerticalOffsetProperty
Field Value
System.Windows.DependencyProperty

ExtentHeightProperty

Identifies the ExtentHeight dependency property.

Declaration
public static readonly DependencyProperty ExtentHeightProperty
Field Value
System.Windows.DependencyProperty

ExtentWidthProperty

Identifies the ExtentWidth dependency property.

Declaration
public static readonly DependencyProperty ExtentWidthProperty
Field Value
System.Windows.DependencyProperty

FooterRowProperty

Identifies the FooterRow dependency property.

Declaration
public static readonly DependencyProperty FooterRowProperty
Field Value
System.Windows.DependencyProperty

HeaderRowProperty

Identifies the HeaderRow dependency property.

Declaration
public static readonly DependencyProperty HeaderRowProperty
Field Value
System.Windows.DependencyProperty

HorizontalOffsetProperty

Identifies the HorizontalOffset dependency property.

Declaration
public static readonly DependencyProperty HorizontalOffsetProperty
Field Value
System.Windows.DependencyProperty

IsCustomScrollingEnabledProperty

Identifies the IsCustomScrollingEnabled dependency property.

Declaration
public static readonly DependencyProperty IsCustomScrollingEnabledProperty
Field Value
System.Windows.DependencyProperty

IsDeferredScrollingEnabledProperty

Identifies the IsDeferredScrollingEnabled dependency property.

Declaration
public static readonly DependencyProperty IsDeferredScrollingEnabledProperty
Field Value
System.Windows.DependencyProperty

NewRowProperty

Identifies the NewRow dependency property.

Declaration
public static readonly DependencyProperty NewRowProperty
Field Value
System.Windows.DependencyProperty

ScrollableHeightProperty

Identifies the ScrollableHeight dependency property.

Declaration
public static readonly DependencyProperty ScrollableHeightProperty
Field Value
System.Windows.DependencyProperty

ScrollableWidthProperty

Identifies the ScrollableWidth dependency property.

Declaration
public static readonly DependencyProperty ScrollableWidthProperty
Field Value
System.Windows.DependencyProperty

ScrollChangedEvent

Identifies the ScrollChanged routed event.

Declaration
public static readonly RoutedEvent ScrollChangedEvent
Field Value
RoutedEvent

VerticalOffsetProperty

Identifies the VerticalOffset dependency property.

Declaration
public static readonly DependencyProperty VerticalOffsetProperty
Field Value
System.Windows.DependencyProperty

ViewportHeightProperty

Identifies the ViewportHeight dependency property.

Declaration
public static readonly DependencyProperty ViewportHeightProperty
Field Value
System.Windows.DependencyProperty

ViewportWidthProperty

Identifies the ViewportWidth dependency property.

Declaration
public static readonly DependencyProperty ViewportWidthProperty
Field Value
System.Windows.DependencyProperty

Properties

CanContentScroll

Gets or sets a value that indicates whether elements that support the IScrollInfo interface are allowed to scroll. This is a dependency property.

Declaration
public bool CanContentScroll { get; set; }
Property Value
System.Boolean

CanHorizontallyScroll

Gets value whether horizontal scrolling is possible.

Declaration
public bool CanHorizontallyScroll { get; }
Property Value
System.Boolean

CanVerticallyScroll

Gets value whether vertical scrolling is possible.

Declaration
public bool CanVerticallyScroll { get; }
Property Value
System.Boolean

ComputedHorizontalScrollBarVisibility

Gets a value that indicates whether the horizontal ScrollBar is visible. This is a dependency property.

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

ComputedVerticalScrollBarVisibility

Gets a value that indicates whether the vertical ScrollBar is visible. This is a dependency property.

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

ContentHorizontalOffset

Gets the horizontal offset of the visible content.

Declaration
public double ContentHorizontalOffset { get; }
Property Value
System.Double

ContentVerticalOffset

Gets the vertical offset of the visible content.

Declaration
public double ContentVerticalOffset { get; }
Property Value
System.Double

ExtentHeight

Gets a value that contains the vertical size of the extent. This is a dependency property.

Declaration
public double ExtentHeight { get; }
Property Value
System.Double

ExtentWidth

Gets a value that contains the horizontal size of the extent. This is a dependency property.

Declaration
public double ExtentWidth { get; }
Property Value
System.Double

FooterRow

Gets or sets the FooterRow.

Declaration
public GridViewFooterRow FooterRow { get; set; }
Property Value
GridViewFooterRow

HandlesScrolling

Gets a value that indicates that a control has a GridViewScrollViewer defined in its style that defines custom keyboard scrolling behavior.

Declaration
protected virtual bool HandlesScrolling { get; }
Property Value
System.Boolean

HeaderRow

Gets or sets the HeaderRow.

Declaration
public GridViewHeaderRow HeaderRow { get; set; }
Property Value
GridViewHeaderRow

HorizontalOffset

Gets a value that contains the horizontal offset of the scrolled content. This is a dependency property.

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

HorizontalScrollBarVisibility

Gets or sets a value that indicates whether a horizontal ScrollBar should be displayed. This is a dependency property.

Declaration
public ScrollBarVisibility HorizontalScrollBarVisibility { get; set; }
Property Value
System.Windows.Controls.ScrollBarVisibility

IsCustomScrollingEnabled

Gets a value indicating whether the grid vertical scrolling is handled internally or not.

Declaration
public bool IsCustomScrollingEnabled { get; set; }
Property Value
System.Boolean

IsDeferredScrollingEnabled

Gets or sets a value that indicates whether the content is stationary when the user drags the Thumb of a ScrollBar.

Declaration
public bool IsDeferredScrollingEnabled { get; set; }
Property Value
System.Boolean

NewRow

Gets or sets the NewRow.

Declaration
public GridViewNewRow NewRow { get; set; }
Property Value
GridViewNewRow

ScrollableHeight

Gets a value that represents the vertical size of the content element that can be scrolled. This is a dependency property.

Declaration
public double ScrollableHeight { get; }
Property Value
System.Double

ScrollableWidth

Gets a value that represents the horizontal size of the content element that can be scrolled. This is a dependency property.

Declaration
public double ScrollableWidth { get; }
Property Value
System.Double

ScrollInfo

Gets or sets the element that implements the IScrollInfo interface and provides values for scrolling properties of this GridViewScrollViewer.

Declaration
protected IScrollInfo ScrollInfo { get; set; }
Property Value
IScrollInfo

VerticalOffset

Gets a value that contains the vertical offset of the scrolled content. This is a dependency property.

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

VerticalScrollBarVisibility

Gets or sets a value that indicates whether a vertical ScrollBar should be displayed. This is a dependency property.

Declaration
public ScrollBarVisibility VerticalScrollBarVisibility { get; set; }
Property Value
System.Windows.Controls.ScrollBarVisibility

ViewportHeight

Gets a value that contains the vertical size of the content's viewport. This is a dependency property.

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

ViewportWidth

Gets a value that contains the horizontal size of the content's viewport. This is a dependency property.

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

Methods

add_ScrollChanged(ScrollChangedEventHandler)

Declaration
public void add_ScrollChanged(ScrollChangedEventHandler value)
Parameters
ScrollChangedEventHandler value

GetIsDeferredScrollingEnabled(DependencyObject)

Returns the value of the IsDeferredScrollingEnabled property for the specified object.

Declaration
public static bool GetIsDeferredScrollingEnabled(DependencyObject element)
Parameters
System.Windows.DependencyObject element

The object from which to get IsDeferredScrollingEnabled.
Returns
System.Boolean

true if the content is stationary when the user drags the Thumb of a ScrollBar; otherwise, false.

InvalidateScrollInfo()

Called by an IScrollInfo interface that is attached to a GridViewScrollViewer when the value of any scrolling property size changes. Scrolling properties include offset, extent, or viewport.

Declaration
public void InvalidateScrollInfo()

LineDown()

Scrolls the ScrollViewer content downward by one line.

Declaration
public void LineDown()

LineLeft()

Scrolls the ScrollViewer content to the left by a predetermined amount.

Declaration
public void LineLeft()

LineRight()

Scrolls the ScrollViewer content to the right by a predetermined amount.

Declaration
public void LineRight()

LineUp()

Scrolls the ScrollViewer content upward by one line.

Declaration
public void LineUp()

MeasureOverride(Size)

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

Returns
System.Windows.Size

OnApplyTemplate()

Declaration
public override void OnApplyTemplate()

OnCreateAutomationPeer()

Provides an appropriate AutomationPeer implementation for this control.

Declaration
protected override AutomationPeer OnCreateAutomationPeer()
Returns
System.Windows.Automation.Peers.AutomationPeer

GridViewScrollViewerAutomationPeer.

OnKeyDown(KeyEventArgs)

Declaration
protected override void OnKeyDown(KeyEventArgs e)
Parameters
System.Windows.Input.KeyEventArgs e

OnMouseLeftButtonDown(MouseButtonEventArgs)

Declaration
protected override void OnMouseLeftButtonDown(MouseButtonEventArgs e)
Parameters
System.Windows.Input.MouseButtonEventArgs e

OnMouseWheel(MouseWheelEventArgs)

Declaration
protected override void OnMouseWheel(MouseWheelEventArgs e)
Parameters
System.Windows.Input.MouseWheelEventArgs e

OnScrollChanged(ScrollChangedEventArgs)

Called when a change in scrolling state is detected, such as a change in scroll position, extent, or viewport size.

Declaration
protected virtual void OnScrollChanged(ScrollChangedEventArgs e)
Parameters
ScrollChangedEventArgs e

The ScrollChangedEventArgs that contain information about the change in the scrolling state.

PageDown()

Scrolls the ScrollViewer content downward by one page.

Declaration
public void PageDown()

PageLeft()

Scrolls the ScrollViewer content to the left by one page.

Declaration
public void PageLeft()

PageRight()

Scrolls the ScrollViewer content to the right by one page.

Declaration
public void PageRight()

PageUp()

Scrolls the ScrollViewer content upward by one page.

Declaration
public void PageUp()

remove_ScrollChanged(ScrollChangedEventHandler)

Declaration
public void remove_ScrollChanged(ScrollChangedEventHandler value)
Parameters
ScrollChangedEventHandler value

ScrollToBottom()

Scrolls vertically to the end of the ScrollViewer content.

Declaration
public void ScrollToBottom()

ScrollToEnd()

Scrolls vertically to the end of the ScrollViewer content.

Declaration
public void ScrollToEnd()

ScrollToHome()

Scrolls vertically to the beginning of the ScrollViewer content.

Declaration
public void ScrollToHome()

ScrollToHorizontalOffset(Double)

Scrolls the content within the ScrollViewer to the specified horizontal offset position.

Declaration
public void ScrollToHorizontalOffset(double offset)
Parameters
System.Double offset

The position that the content scrolls to.

ScrollToLeftEnd()

Scrolls horizontally to the beginning of the ScrollViewer content.

Declaration
public void ScrollToLeftEnd()

ScrollToRightEnd()

Scrolls horizontally to the end of the ScrollViewer content.

Declaration
public void ScrollToRightEnd()

ScrollToTop()

Scrolls vertically to the beginning of the ScrollViewer content.

Declaration
public void ScrollToTop()

ScrollToVerticalOffset(Double)

Scrolls the content within the ScrollViewer to the specified vertical offset position.

Declaration
public void ScrollToVerticalOffset(double offset)
Parameters
System.Double offset

The position that the content scrolls to.

SetIsDeferredScrollingEnabled(DependencyObject, Boolean)

Sets the IsDeferredScrollingEnabled property for the specified object.

Declaration
public static void SetIsDeferredScrollingEnabled(DependencyObject element, bool value)
Parameters
System.Windows.DependencyObject element

The object on which to set the IsDeferredScrollingEnabled property.
System.Boolean value

True to have the content remain stationary when the user drags the Thumb of a ScrollBar; otherwise, false.

Events

ScrollChanged

Occurs when changes are detected to the scroll position, extent, or viewport size.

Declaration
public event ScrollChangedEventHandler ScrollChanged
Event Type
ScrollChangedEventHandler

Extension Methods