ClassRadScrollViewer
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.
Definition
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, IScrollViewerInheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadScrollViewer
Derived Classes:
Implements:
Inherited Members
Constructors
RadScrollViewer()
Declaration
public RadScrollViewer()RadScrollViewer(RadElement)
Declaration
public RadScrollViewer(RadElement viewport)Parameters
viewport
Properties
CanHorizontalScroll
Declaration
[Browsable(false)]
public bool CanHorizontalScroll { get; }Property Value
CanVerticalScroll
Declaration
[Browsable(false)]
public bool CanVerticalScroll { get; }Property Value
FillElement
Declaration
[Browsable(false)]
public RadElement FillElement { get; }Property Value
ForceViewportHeight
Declaration
[Browsable(false)]
public bool ForceViewportHeight { get; set; }Property Value
ForceViewportWidth
Declaration
[Browsable(false)]
public bool ForceViewportWidth { get; set; }Property Value
HorizontalScrollBar
Declaration
[Browsable(false)]
public RadScrollBarElement HorizontalScrollBar { get; }Property Value
HorizontalScrollState
Declaration
[Browsable(true)]
public ScrollState HorizontalScrollState { get; set; }Property Value
PixelsPerLineScroll
Declaration
[Browsable(true)]
public Point PixelsPerLineScroll { get; set; }Property Value
ScrollLayoutPanel
Declaration
public RadScrollLayoutPanel ScrollLayoutPanel { get; }Property Value
ScrollThickness
Declaration
[Browsable(true)]
public int ScrollThickness { get; set; }Property Value
ShowBorder
Gets or sets a value indicating whether the border is shown.
Declaration
[Browsable(true)]
public bool ShowBorder { get; set; }Property Value
ShowFill
Gets or sets a value indicating whether the fill is shown.
Declaration
[Browsable(true)]
public bool ShowFill { get; set; }Property Value
UsePhysicalScrolling
Declaration
[Browsable(true)]
public bool UsePhysicalScrolling { get; set; }Property Value
Value
Declaration
[Browsable(true)]
public Point Value { get; set; }Property Value
VerticalScrollBar
Declaration
[Browsable(false)]
public RadScrollBarElement VerticalScrollBar { get; }Property Value
VerticalScrollState
Declaration
[Browsable(true)]
public ScrollState VerticalScrollState { get; set; }Property Value
Viewport
Declaration
[Browsable(false)]
public virtual RadElement Viewport { get; set; }Property Value
Virtualized
Gets whether the scroll viewer uses a virtualized viewport
Declaration
[Browsable(true)]
public virtual bool Virtualized { get; set; }Property Value
Implements
Methods
CreateChildElements()
Called by the element when constructed. Allows inheritors to build the element tree.
Declaration
protected override void CreateChildElements()Overrides
CreateScrollLayoutPanel()
Declaration
protected virtual RadScrollLayoutPanel CreateScrollLayoutPanel()Returns
InitializeFields()
Initializes the fields of this instance with their default values.
Declaration
protected override void InitializeFields()Overrides
LineDown()
Scrolls down within viewport by one logical unit.
Declaration
public void LineDown()Implements
LineLeft()
Scrolls left within viewport by one logical unit.
Declaration
public void LineLeft()Implements
LineRight()
Scrolls right within viewport by one logical unit.
Declaration
public void LineRight()Implements
LineUp()
Scrolls up within viewport by one logical unit.
Declaration
public void LineUp()Implements
OnPropertyChanged(RadPropertyChangedEventArgs)
Called when a property value has changed, handling item-specific property change logic including text, visual state, and animation properties.
Declaration
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)Parameters
e
The property changed event arguments.
Overrides
OnScroll(ScrollPanelEventArgs)
Declaration
protected virtual void OnScroll(ScrollPanelEventArgs args)Parameters
args
OnScrollNeedsChanged(ScrollNeedsEventArgs)
Declaration
protected virtual void OnScrollNeedsChanged(ScrollNeedsEventArgs args)Parameters
args
OnScrollParametersChanged(RadPanelScrollParametersEventArgs)
Declaration
protected virtual void OnScrollParametersChanged(RadPanelScrollParametersEventArgs args)Parameters
args
PageDown()
Scrolls down within viewport by one page.
Declaration
public void PageDown()Implements
PageLeft()
Scrolls left within viewport by one page.
Declaration
public void PageLeft()Implements
PageRight()
Scrolls right within viewport by one page.
Declaration
public void PageRight()Implements
PageUp()
Scrolls up within viewport by one page.
Declaration
public void PageUp()Implements
ScrollElementIntoView(RadElement)
Declaration
public void ScrollElementIntoView(RadElement element)Parameters
element
Implements
ScrollToBottom()
Scrolls vertically to the end of the content.
Declaration
public void ScrollToBottom()Implements
ScrollToEnd()
Scrolls both horizontally and vertically to the end of the content.
Declaration
public void ScrollToEnd()Implements
ScrollToHome()
Scrolls both horizontally and vertically to the beginning of the content.
Declaration
public void ScrollToHome()Implements
ScrollToLeftEnd()
Scrolls horizontally to the beginning of the content.
Declaration
public void ScrollToLeftEnd()Implements
ScrollToRightEnd()
Scrolls horizontally to the end of the content.
Declaration
public void ScrollToRightEnd()Implements
ScrollToTop()
Scrolls vertically to the beginning of the content.
Declaration
public void ScrollToTop()Implements
Events
Scroll
Declaration
public event RadScrollPanelHandler ScrollEvent Value
ScrollNeedsChanged
Declaration
public event ScrollNeedsHandler ScrollNeedsChangedEvent Value
ScrollParametersChanged
Declaration
public event RadPanelScrollParametersHandler ScrollParametersChangedEvent Value