Class RadScrollViewer

The only implementation of IScrollViewer and base class of all scrollable elements.

This class contains one element called Viewport. In addition to the ordinary property Size, Viewport has parameter called "extent size" which represents the real size of its content. Extent size could be bigger as well as smaller than the size of the scroll viewer.

There are two types of viewports: ordinary elements and elements that implement IRadScrollViewport. In the first case extent size is the size of the viewport itself. The scrolling is done on pixel basis and via painting offset of the viewport (it is called physical scrolling). In the second case the functions that are declared in IRadScrollViewport are called for getting extent size and performing the scroll operation (this is called logical scrolling).

If the viewport implementation is of type IRadScrollViewport it still can be physically scrolled by setting the property UsePhysicalScrolling to true.

Physical scrolling has one parameter that can be set - PixelsPerLineScroll which represents the small change value for the scrolling (i.e. the number of pixels for Line Up/Down/Left/Right). The large change (Page Up/Down/Left/Right) is the corresponding size of the viewable size of the viewport.

For more information about custom viewports and logical scrolling - see IRadScrollViewport.

Current scroll position can be get or set via the property Value. In addition scrolling can be performed by calling the methods that are implemented from IScrollViewer.

Inheritance
System.Object
DisposableObject
RadObject
RadElement
VisualElement
RadComponentElement
RadItem
RadScrollViewer
Inherited Members
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

public class RadScrollViewer : RadItem, INotifyPropertyChanged, ICustomTypeDescriptor, ISupportSystemSkin, IBindableComponent, IComponent, IDisposable, ISupportDrag, ISupportDrop, IShortcutProvider, IStylableElement, IStylableNode, IScrollViewer

Constructors

RadScrollViewer()

Declaration
public RadScrollViewer()

RadScrollViewer(RadElement)

Declaration
public RadScrollViewer(RadElement viewport)
Parameters
RadElement viewport

Properties

CanHorizontalScroll

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

CanVerticalScroll

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

FillElement

Declaration
public RadElement FillElement { get; }
Property Value
RadElement

ForceViewportHeight

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

ForceViewportWidth

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

HorizontalScrollBar

Declaration
public RadScrollBarElement HorizontalScrollBar { get; }
Property Value
RadScrollBarElement

HorizontalScrollState

Declaration
[RadDescription("HorizontalScrollState", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("HorizontalScrollState", typeof(RadScrollLayoutPanel))]
public ScrollState HorizontalScrollState { get; set; }
Property Value
ScrollState

MaxValue

Declaration
[RadDescription("MaxValue", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("MaxValue", typeof(RadScrollLayoutPanel))]
public Point MaxValue { get; }
Property Value
System.Drawing.Point

MinValue

Declaration
[RadDefaultValue("MinValue", typeof(RadScrollLayoutPanel))]
[RadDescription("MinValue", typeof(RadScrollLayoutPanel))]
public Point MinValue { get; }
Property Value
System.Drawing.Point

PixelsPerLineScroll

Declaration
[RadDefaultValue("PixelsPerLineScroll", typeof(RadScrollLayoutPanel))]
[RadDescription("PixelsPerLineScroll", typeof(RadScrollLayoutPanel))]
public Point PixelsPerLineScroll { get; set; }
Property Value
System.Drawing.Point

ScrollLayoutPanel

Declaration
public RadScrollLayoutPanel ScrollLayoutPanel { get; }
Property Value
RadScrollLayoutPanel

ScrollThickness

Declaration
[RadDescription("ScrollThickness", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("ScrollThickness", typeof(RadScrollLayoutPanel))]
public int ScrollThickness { get; set; }
Property Value
System.Int32

ShowBorder

Gets or sets a value indicating whether the border is shown.

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

ShowFill

Gets or sets a value indicating whether the fill is shown.

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

UsePhysicalScrolling

Declaration
[RadDescription("UsePhysicalScrolling", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("UsePhysicalScrolling", typeof(RadScrollLayoutPanel))]
public bool UsePhysicalScrolling { get; set; }
Property Value
System.Boolean

Value

Declaration
[RadDescription("Value", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("Value", typeof(RadScrollLayoutPanel))]
public Point Value { get; set; }
Property Value
System.Drawing.Point

VerticalScrollBar

Declaration
public RadScrollBarElement VerticalScrollBar { get; }
Property Value
RadScrollBarElement

VerticalScrollState

Declaration
[RadDescription("VerticalScrollState", typeof(RadScrollLayoutPanel))]
[RadDefaultValue("VerticalScrollState", typeof(RadScrollLayoutPanel))]
public ScrollState VerticalScrollState { get; set; }
Property Value
ScrollState

Viewport

Declaration
public virtual RadElement Viewport { get; set; }
Property Value
RadElement

Virtualized

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

Implements

Methods

CreateChildElements()

Declaration
protected override void CreateChildElements()
Overrides

CreateScrollLayoutPanel()

Declaration
protected virtual RadScrollLayoutPanel CreateScrollLayoutPanel()
Returns
RadScrollLayoutPanel

InitializeFields()

Declaration
protected override void InitializeFields()
Overrides

LineDown()

Declaration
public void LineDown()
Implements

LineLeft()

Declaration
public void LineLeft()
Implements

LineRight()

Declaration
public void LineRight()
Implements

LineUp()

Declaration
public void LineUp()
Implements

OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters
RadPropertyChangedEventArgs e

Overrides

OnScroll(ScrollPanelEventArgs)

Declaration
protected virtual void OnScroll(ScrollPanelEventArgs args)
Parameters
ScrollPanelEventArgs args

OnScrollNeedsChanged(ScrollNeedsEventArgs)

Declaration
protected virtual void OnScrollNeedsChanged(ScrollNeedsEventArgs args)
Parameters
ScrollNeedsEventArgs args

OnScrollParametersChanged(RadPanelScrollParametersEventArgs)

Declaration
protected virtual void OnScrollParametersChanged(RadPanelScrollParametersEventArgs args)
Parameters
RadPanelScrollParametersEventArgs args

PageDown()

Declaration
public void PageDown()
Implements

PageLeft()

Declaration
public void PageLeft()
Implements

PageRight()

Declaration
public void PageRight()
Implements

PageUp()

Declaration
public void PageUp()
Implements

ScrollElementIntoView(RadElement)

Declaration
public void ScrollElementIntoView(RadElement element)
Parameters
RadElement element

Implements

ScrollToBottom()

Declaration
public void ScrollToBottom()
Implements

ScrollToEnd()

Declaration
public void ScrollToEnd()
Implements

ScrollToHome()

Declaration
public void ScrollToHome()
Implements

ScrollToLeftEnd()

Declaration
public void ScrollToLeftEnd()
Implements

ScrollToRightEnd()

Declaration
public void ScrollToRightEnd()
Implements

ScrollToTop()

Declaration
public void ScrollToTop()
Implements

Events

Scroll

Declaration
public event RadScrollPanelHandler Scroll
Event Type
RadScrollPanelHandler

ScrollNeedsChanged

Declaration
public event ScrollNeedsHandler ScrollNeedsChanged
Event Type
ScrollNeedsHandler

ScrollParametersChanged

Declaration
public event RadPanelScrollParametersHandler ScrollParametersChanged
Event Type
RadPanelScrollParametersHandler

Extension Methods