New to Telerik UI for WinForms? Start a free 30-day trial

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:

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

Inheritance: objectDisposableObjectRadObjectRadElementVisualElementRadComponentElementRadItemRadScrollViewer...

Derived Classes: AIPromptContainer

Implements: IBindableComponentIComponentICustomTypeDescriptorIDisposableINotifyPropertyChangedIScrollViewerIShortcutProviderIStylableElementIStylableNodeISupportDragISupportDropISupportSystemSkin...

Inherited Members RadItem.KeyDownEventRadItem.KeyPressEventRadItem.KeyUpEventRadItem.FocusCommandRadItem.ActionCommandRadItem.UseDefaultDisabledPaintPropertyRadItem.TextPropertyRadItem.TextOrientationPropertyRadItem.FlipTextPropertyRadItem.IsAddNewItemPropertyRadItem.ToolTipTextPropertyRadItem.EnableElementShadowPropertyRadItem.ShadowDepthPropertyRadItem.ShadowColorPropertyRadItem.IsPaintingRippleRadItem.EnableRippleAnimationPropertyRadItem.RippleAnimationColorPropertyRadItem.EnableFocusBorderPropertyRadItem.FocusBorderColorPropertyRadItem.FocusBorderWidthPropertyRadItem.EnableFocusBorderAnimationPropertyRadItem.EnableHighlightPropertyRadItem.HighlightColorPropertyRadItem.EnableBorderHighlightPropertyRadItem.BorderHighlightColorPropertyRadItem.BorderHighlightThicknessPropertyRadItem.VisualStatePropertyRadItem.SetOwnerCollection(RadItemOwnerCollection)RadItem.DisposeManagedResources()RadItem.Select()RadItem.OnSelect()RadItem.Deselect()RadItem.OnDeselect()RadItem.DoKeyDown(KeyEventArgs)RadItem.DoKeyPress(KeyPressEventArgs)RadItem.DoKeyUp(KeyEventArgs)RadItem.OnKeyDown(KeyEventArgs)RadItem.OnKeyPress(KeyPressEventArgs)RadItem.OnKeyUp(KeyEventArgs)RadItem.RaiseBubbleEvent(RadElement, RoutedEventArgs)RadItem.OnPropertyChanging(RadPropertyChangingEventArgs)RadItem.OnEnabledChanged(RadPropertyChangedEventArgs)RadItem.OnTextChanging(TextChangingEventArgs)RadItem.OnTextChanged(EventArgs)RadItem.OnTextOrientationChanged(EventArgs)RadItem.OnFlipTextChanged(EventArgs)RadItem.PaintOverride(IGraphics, Rectangle, float, SizeF, bool)RadItem.OnMouseDown(MouseEventArgs)RadItem.OnMouseUp(MouseEventArgs)RadItem.OnMouseMove(MouseEventArgs)RadItem.OnMouseLeave(EventArgs)RadItem.StartRippleAnimation(MouseEventArgs)RadItem.UpdateFocusBorder(bool)RadItem.ContainsText()RadItem.ShouldSerializeProperty(PropertyDescriptor)RadItem.ProcessDialogKey(Keys)RadItem.ProcessCmdKey(ref Message, Keys)RadItem.RaiseKeyDown(KeyEventArgs)RadItem.RaiseKeyPress(KeyPressEventArgs)RadItem.RaiseKeyUp(KeyEventArgs)RadItem.ReplaceDefaultDescriptors(PropertyDescriptorCollection)RadItem.CallOnGesture(GestureEventArgs)RadItem.OnGesture(GestureEventArgs)RadItem.OnTwoFingerTapGesture(GestureEventArgs)RadItem.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadItem.OnPanGesture(PanGestureEventArgs)RadItem.OnRotateGesture(RotateGestureEventArgs)RadItem.OnZoomGesture(ZoomGestureEventArgs)RadItem.CanDragCore(Point)RadItem.GetDragContextCore()RadItem.GetDragHintCore()RadItem.ProcessDragDrop(Point, ISupportDrag)RadItem.ProcessDragOver(Point, ISupportDrag)RadItem.ProcessDragEnter(Point, ISupportDrag)RadItem.ProcessDragLeave(Point, ISupportDrag)RadItem.UpdateOnShortcutsChanged()RadItem.CanHandleShortcut(ShortcutEventArgs)RadItem.IsOnActiveForm(Control, bool)RadItem.SetThemeValueOverride(RadProperty, object, string)RadItem.SetThemeValueOverride(RadProperty, object, string, string)RadItem.SetThemeValueOverride(RadProperty, object, string, Type)RadItem.ResetThemeValueOverride(RadProperty)RadItem.ResetThemeValueOverride(RadProperty, string)RadItem.ResetThemeValueOverrides()RadItem.GetAvailableVisualStates()RadItem.ShouldFallbackToDefaultTheme()RadItem.UseDefaultDisabledPaintRadItem.TextOrientationRadItem.FlipTextRadItem.CanHaveOwnStyleRadItem.TextRadItem.SelectableRadItem.DefaultAutoToolTipRadItem.ShouldHandleMouseInputRadItem.KeyTipRadItem.ParentItemRadItem.ShortcutsHandlerRadItem.EnableElementShadowRadItem.ShadowDepthRadItem.ShadowColorRadItem.EnableRippleAnimationRadItem.RippleAnimationColorRadItem.EnableFocusBorderRadItem.FocusBorderColorRadItem.FocusBorderWidthRadItem.EnableFocusBorderAnimationRadItem.EnableHighlightRadItem.HighlightColorRadItem.EnableBorderHighlightRadItem.BorderHighlightColorRadItem.BorderHighlightThicknessRadItem.MnemonicTextRadItem.ToolTipTextRadItem.ThemeRoleRadItem.VisualStateRadItem.StateManagerRadItem.AllowDragRadItem.AllowDropRadItem.ShortcutsRadItem.AccessibleDescriptionRadItem.AccessibleNameRadItem.AccessibleRoleRadItem.TextChangingRadItem.TextChangedRadItem.TextOrientationChangedRadItem.FlipTextChangedRadItem.QueryAccessibilityHelpRadItem.KeyDownRadItem.KeyPressRadItem.KeyUpRadItem.ZoomGestureRadItem.RotateGestureRadItem.PanGestureRadItem.TwoFingerTapGestureRadItem.PressAndTapGestureRadComponentElement.ToString()RadComponentElement.GetService(Type)RadComponentElement.CanRaiseEventsRadComponentElement.ContainerRadComponentElement.DesignModeRadComponentElement.SiteRadComponentElement.DataBindingsVisualElement.DefaultSizePropertyVisualElement.ForeColorPropertyVisualElement.BackColorPropertyVisualElement.FontPropertyVisualElement.SmoothingModePropertyVisualElement.OpacityPropertyVisualElement.CustomFontPropertyVisualElement.CustomFontSizePropertyVisualElement.CustomFontStylePropertyVisualElement.OnFontChanged(EventArgs)VisualElement.PaintElement(IGraphics, float, SizeF)VisualElement.PaintChildren(IGraphics, Rectangle, float, SizeF, bool)VisualElement.PrePaintElement(IGraphics)VisualElement.PostPaintElement(IGraphics)VisualElement.GetScaledFont(float)VisualElement.GetScaledFont(float, Font)VisualElement.DefaultSizeVisualElement.ForeColorVisualElement.BackColorVisualElement.FontVisualElement.CustomFontVisualElement.CustomFontSizeVisualElement.CustomFontStyleVisualElement.SmoothingModeVisualElement.OpacityVisualElement.FontChangedRadElement.BoundsPropertyRadElement.BorderThicknessPropertyRadElement.PaddingPropertyRadElement.MarginPropertyRadElement.AlignmentPropertyRadElement.AutoSizeModePropertyRadElement.FitToSizeModePropertyRadElement.MinSizePropertyRadElement.EnabledPropertyRadElement.CanFocusPropertyRadElement.IsItemFocusedPropertyRadElement.IsFocusedPropertyRadElement.IsMouseOverPropertyRadElement.IsMouseOverElementPropertyRadElement.IsMouseDownPropertyRadElement.ShouldPaintPropertyRadElement.VisibilityPropertyRadElement.NamePropertyRadElement.ClassPropertyRadElement.ClipDrawingPropertyRadElement.ShapePropertyRadElement.MouseClickedEventRadElement.MouseDoubleClickedEventRadElement.MouseDownEventRadElement.MouseUpEventRadElement.MouseWheelEventRadElement.ChildElementAddedEventRadElement.ParentChangedEventRadElement.BoundsChangedEventRadElement.VisibilityChangingEventRadElement.EnabledChangedEventRadElement.ControlChangedEventRadElement.BackgroundShapePropertyRadElement.BackgroundShapePaintModePropertyRadElement.ContainsFocusPropertyRadElement.ContainsMousePropertyRadElement.MaxSizePropertyRadElement.RightToLeftPropertyRadElement.AutoSizePropertyRadElement.ZIndexPropertyRadElement.AngleTransformPropertyRadElement.ScaleTransformPropertyRadElement.PositionOffsetPropertyRadElement.TagPropertyRadElement.StretchHorizontallyPropertyRadElement.StretchVerticallyPropertyRadElement.UseCompatibleTextRenderingPropertyRadElement.ClickModePropertyRadElement.styleVersionRadElement.paintSystemSkinRadElement.SetPropertyValueCommandRadElement.GetPropertyValueCommandRadElement.StylePropertyRadElement.CallCreateChildElements()RadElement.SuspendReferenceUpdate()RadElement.ResumeReferenceUpdate()RadElement.OnLoad(bool)RadElement.LoadCore()RadElement.OnLoaded()RadElement.OnUnload(ComponentThemableElementTree, bool)RadElement.UnloadCore(ComponentThemableElementTree)RadElement.OnUnloaded(ComponentThemableElementTree)RadElement.OnElementTreeChanged(ComponentThemableElementTree)RadElement.OnBeginDispose()RadElement.SetParent(RadElement)RadElement.OnParentChanged(RadElement)RadElement.UpdateReferences(ComponentThemableElementTree, bool, bool)RadElement.ResetLayout(bool)RadElement.HasInvisibleAncestor()RadElement.ResetLayoutCore()RadElement.InvalidateArrange()RadElement.InvalidateArrange(bool)RadElement.InvalidateMeasure()RadElement.InvalidateMeasure(bool)RadElement.UpdateLayout()RadElement.SuspendLayout()RadElement.SuspendLayout(bool)RadElement.ResumeLayout(bool)RadElement.ResumeLayout(bool, bool)RadElement.Arrange(RectangleF)RadElement.Measure(SizeF)RadElement.SetBounds(Rectangle)RadElement.SetBounds(int, int, int, int)RadElement.GetBoundingRectangle(Size)RadElement.GetBoundingRectangle(Rectangle)RadElement.GetDesiredSize(bool)RadElement.PointToScreen(Point)RadElement.PointFromScreen(Point)RadElement.PointToControl(Point)RadElement.PointFromControl(Point)RadElement.LocationToControl()RadElement.RectangleToScreen(Rectangle)RadElement.HitTest(Point)RadElement.OnRenderSizeChanged(SizeChangedInfo)RadElement.OnChildDesiredSizeChanged(RadElement)RadElement.OnLayoutPropertyChanged(RadPropertyChangedEventArgs)RadElement.ArrangeCore(RectangleF)RadElement.MeasureCore(SizeF)RadElement.ShouldArrangeChild(RadElement)RadElement.ArrangeOverride(SizeF)RadElement.ShouldMeasureChild(RadElement)RadElement.MeasureChildren(SizeF)RadElement.GetArrangeRect(RectangleF)RadElement.CanExecuteLayoutOperation()RadElement.CalcLayoutOffset(PointF)RadElement.LockBounds()RadElement.UnlockBounds()RadElement.SetBoundsCore(Rectangle)RadElement.IsInValidState(bool)RadElement.Invalidate()RadElement.Invalidate(bool)RadElement.GetInvalidateBounds()RadElement.NotifyInvalidate(RadElement)RadElement.OnTransformationInvalidated()RadElement.PerformLayoutTransformation(ref RadMatrix)RadElement.PerformPaintTransformation(ref RadMatrix)RadElement.IsInGetAsBitmap()RadElement.PaintElementSkin(IGraphics)RadElement.PaintBackgroundShape(IGraphics)RadElement.PostPaintChildren(IGraphics, Rectangle, float, SizeF)RadElement.PaintChild(RadElement, IGraphics, Rectangle, float, SizeF, bool)RadElement.PaintShadow(RadElement, IGraphics)RadElement.PaintShadowCore(Graphics, Rectangle, RadItem)RadElement.GetShadowRect(ref Rectangle, int)RadElement.PaintFocusCues(IGraphics, Rectangle)RadElement.GetAsBitmap(IGraphics, Brush, float, SizeF)RadElement.GetAsTransformedBitmap(IGraphics, Brush, float, SizeF)RadElement.GetAsTransformedBitmap(Brush, float, SizeF)RadElement.GetAsTransformedBitmap(Rectangle, Brush, float, SizeF)RadElement.GetAsBitmapEx(Color, float, SizeF)RadElement.GetAsBitmapEx(Brush, float, SizeF)RadElement.GetAsBitmap(Brush, float, SizeF)RadElement.IsInVisibleClipBounds(Rectangle)RadElement.SetClipping(Graphics)RadElement.GetClipRect()RadElement.ShouldPaintChild(RadElement)RadElement.GetFocusRect()RadElement.GetCurrentShape()RadElement.GetPaintRectangle(float, float, SizeF)RadElement.GetPatchedRect(RectangleF, float, SizeF)RadElement.GetXPVisualStyle()RadElement.GetVistaVisualStyle()RadElement.InitializeSystemSkinPaint()RadElement.UnitializeSystemSkinPaint()RadElement.GetSystemSkinPaintBounds()RadElement.OnUseSystemSkinChanged(EventArgs)RadElement.ShouldPaintSystemSkin()RadElement.ComposeShouldPaintSystemSkin()RadElement.GetStylablePropertiesFilter()RadElement.ResetStyleSettings(bool)RadElement.ResetStyleSettings(bool, RadProperty)RadElement.ProcessBehaviors(RadPropertyChangedEventArgs)RadElement.AddBehavior(PropertyChangeBehavior)RadElement.GetBehaviors()RadElement.RemoveBehavior(PropertyChangeBehavior)RadElement.ClearBehaviors()RadElement.AddRangeBehavior(PropertyChangeBehaviorCollection)RadElement.SetThemeApplied(bool)RadElement.OnStyleChanged(RadPropertyChangedEventArgs)RadElement.UnapplyStyle()RadElement.RemoveRangeBehaviors(PropertyChangeBehaviorCollection)RadElement.RemoveBehaviors(PropertyChangeBehavior)RadElement.RemoveRangeRoutedEventBehaviors(RoutedEventBehaviorCollection)RadElement.GetThemeEffectiveType()RadElement.GetChildrenByType(Type)RadElement.GetChildrenByBaseType(Type)RadElement.FindAncestorByThemeEffectiveType(Type)RadElement.FindAncestor<T>()RadElement.IsAncestorOf(RadElement)RadElement.FindDescendant<T>()RadElement.FindDescendant(Predicate<RadElement>)RadElement.FindDescendant(Type)RadElement.EnumDescendants(TreeTraversalMode)RadElement.EnumDescendants(Predicate<RadElement>, TreeTraversalMode)RadElement.EnumDescendants(Filter, TreeTraversalMode)RadElement.GetDescendants(Predicate<RadElement>, TreeTraversalMode)RadElement.GetDescendants(Filter, TreeTraversalMode)RadElement.GetAncestors(Filter)RadElement.GetAncestors(Predicate<RadElement>)RadElement.RaiseRoutedEvent(RadElement, RoutedEventArgs)RadElement.RaiseTunnelEvent(RadElement, RoutedEventArgs)RadElement.OnTunnelEvent(RadElement, RoutedEventArgs)RadElement.OnBubbleEvent(RadElement, RoutedEventArgs)RadElement.IsEventInProcess(RaisedRoutedEvent)RadElement.RegisterRoutedEvent(string, Type)RadElement.GetRegisterRoutedEvent(string, Type)RadElement.GetRegisterRoutedEvent(string, string)RadElement.GetRegisterRoutedEvent(string)RadElement.OnChildrenChanged(RadElement, ItemsChangeOperation)RadElement.GetChildren(ChildrenListOptions)RadElement.SendToBack()RadElement.BringToFront()RadElement.IsChildOf(RadElement)RadElement.Focus()RadElement.Focus(bool)RadElement.SetFocusPropertySafe(bool)RadElement.KillFocus()RadElement.OnCLREventsRise(RoutedEventArgs)RadElement.OnMouseHover(EventArgs)RadElement.OnParentEnabledChanged(RadPropertyChangedEventArgs)RadElement.OnLostMouseCapture(MouseEventArgs)RadElement.OnClick(EventArgs)RadElement.OnDoubleClick(EventArgs)RadElement.OnMouseEnter(EventArgs)RadElement.PerformClick()RadElement.OnMouseWheel(MouseEventArgs)RadElement.DoMouseWheel(MouseEventArgs)RadElement.DoClick(EventArgs)RadElement.DoDoubleClick(EventArgs)RadElement.IsInputKey(InputKeyEventArgs)RadElement.MouseEventArgsFromControl(MouseEventArgs)RadElement.DoMouseDown(MouseEventArgs)RadElement.DoMouseUp(MouseEventArgs)RadElement.DoMouseMove(MouseEventArgs)RadElement.ShowScreenTip(ScreenTipNeededEventArgs)RadElement.HideScreenTip()RadElement.DoMouseHover(EventArgs)RadElement.OnShowScreenTip(ComponentInputBehavior)RadElement.RaiseClick(EventArgs)RadElement.RaiseDoubleClick(EventArgs)RadElement.RaiseMouseWheel(MouseEventArgs)RadElement.UpdateContainsFocus(bool)RadElement.DoMouseEnter(EventArgs)RadElement.DoMouseLeave(EventArgs)RadElement.GetValue(RadProperty)RadElement.AddStylePropertySetting(IPropertySetting)RadElement.SetValueCore(RadPropertyValue, object, object, ValueSource)RadElement.NotifyChildren(RadPropertyChangedEventArgs)RadElement.OnBoundsChanged(RadPropertyChangedEventArgs)RadElement.OnLocationChanged(RadPropertyChangedEventArgs)RadElement.OnDisplayPropertyChanged(RadPropertyChangedEventArgs)RadElement.CanRaisePropertyChangeNotifications(RadPropertyValue)RadElement.IsPropertyCancelable(RadPropertyMetadata)RadElement.OnParentPropertyChanged(RadPropertyChangedEventArgs)RadElement.PerformDispose(bool)RadElement.DisposeChildren()RadElement.GetStylableChildrenHierarchy()RadElement.GetStylableChildren()RadElement.GetClientRectangle(SizeF)RadElement.GetBorderThickness(BorderPrimitive)RadElement.DpiScaleChanged(SizeF)RadElement.ElementStateRadElement.DesiredSizeRadElement.IsLayoutSuspendedRadElement.BoundingRectangleRadElement.ControlBoundingRectangleRadElement.BypassLayoutPoliciesRadElement.IsArrangeValidRadElement.IsMeasureValidRadElement.TreeLevelRadElement.TransformRadElement.TotalTransformRadElement.ShouldPaintUsingParentShapeRadElement.UseSystemSkinRadElement.PropagateStyleToChildrenRadElement.ThemeEffectiveTypeRadElement.ElementTreeRadElement.ChildrenRadElement.ChildrenHierarchyRadElement.ParentRadElement.RoutedEventBehaviorsRadElement.LayoutableChildrenCountRadElement.ContainsFocusRadElement.NotifyParentOnMouseInputRadElement.IsAbleToRespondToMouseEventsRadElement.AutoSizeRadElement.BoundsRadElement.LocationRadElement.SizeRadElement.BorderThicknessRadElement.PaddingRadElement.MarginRadElement.AlignmentRadElement.AutoSizeModeRadElement.FitToSizeModeRadElement.EnabledRadElement.CanFocusRadElement.IsFocusedRadElement.IsMouseOverRadElement.IsMouseOverElementRadElement.IsMouseDownRadElement.InvalidateChildrenOnChildChangedRadElement.ShouldPaintRadElement.VisibilityRadElement.IsElementVisibleRadElement.NameRadElement.ClassRadElement.ClipDrawingRadElement.ShapeRadElement.MinSizeRadElement.MaxSizeRadElement.ZIndexRadElement.RightToLeftRadElement.UseCompatibleTextRenderingRadElement.BackgroundShapeRadElement.BackgroundShapePaintModeRadElement.ContainsMouseRadElement.CaptureRadElement.ScaleTransformRadElement.AngleTransformRadElement.PositionOffsetRadElement.SerializePropertiesRadElement.SerializeElementRadElement.SerializeChildrenRadElement.RenderingMaxFramerateRadElement.IsThemeAppliedRadElement.ShouldApplyThemeRadElement.UseCenteredAngleTransformRadElement.TagRadElement.StretchHorizontallyRadElement.StretchVerticallyRadElement.ClickModeRadElement.DoubleClickEnabledRadElement.CaptureOnMouseDownRadElement.IsItemHoveredRadElement.StyleRadElement.AutoToolTipRadElement.ScreenTipRadElement.AutoNumberKeyTipRadElement.DpiScaleFactorRadElement.LayoutUpdatedRadElement.MouseHoverRadElement.MouseMoveRadElement.MouseDownRadElement.MouseUpRadElement.ClickRadElement.DoubleClickRadElement.MouseEnterRadElement.MouseWheelRadElement.EnabledChangedRadElement.MouseLeaveRadElement.ChildrenChangedRadElement.LostMouseCaptureRadObject.BindingContextPropertyRadObject.RadTypeRadObject.ClearPropertyStore()RadObject.SuspendPropertyNotifications()RadObject.ResumePropertyNotifications()RadObject.GetPropertyValue(RadProperty)RadObject.SetDefaultValueOverride(RadProperty, object)RadObject.SetValue(RadProperty, object)RadObject.ResetValue(RadProperty)RadObject.ResetLocalValue(RadProperty)RadObject.ResetValue(RadProperty, ValueResetFlags)RadObject.UpdateValue(RadProperty)RadObject.GetValueSource(RadProperty)RadObject.GetRegisteredRadProperty(string)RadObject.UpdateValueCore(RadPropertyValue)RadObject.ResetValueCore(RadPropertyValue, ValueResetFlags)RadObject.GetDefaultValue(RadPropertyValue, object)RadObject.CoerceValue(RadPropertyValue, object)RadObject.ShouldSerializeProperty(RadProperty)RadObject.BindProperty(RadProperty, RadObject, RadProperty, PropertyBindingOptions)RadObject.UnbindProperty(RadProperty)RadObject.GetInheritedValue(RadProperty)RadObject.OnNotifyPropertyChanged(string)RadObject.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadObject.OnShouldSerializeProperty(ShouldSerializePropertyEventArgs)RadObject.PropertyValuesRadObject.PropertyFilterRadObject.RadObjectTypeRadObject.BindingContextRadObject.PropertyChangedRadObject.RadPropertyChangedRadObject.RadPropertyChangingDisposableObject.GetBitState(long)DisposableObject.SetBitState(long, bool)DisposableObject.OnBitStateChanged(long, bool, bool)DisposableObject.Dispose()DisposableObject.Dispose(bool)DisposableObject.DisposeUnmanagedResources()DisposableObject.BitStateDisposableObject.EventsDisposableObject.IsDisposingDisposableObject.IsDisposedDisposableObject.DisposedDisposableObject.Disposing...

Constructors

Creates a scroll viewer with no viewport assigned.

C#
public RadScrollViewer()

Creates a scroll viewer that displays the specified viewport element.

C#
public RadScrollViewer(RadElement viewport)
Parameters:viewportRadElement

The element whose content is scrolled.

Properties

C#
[Browsable(false)]
public bool CanHorizontalScroll { get; }
C#
[Browsable(false)]
public bool CanVerticalScroll { get; }

Gets the fill primitive element rendered behind the viewport; use ShowFill to toggle its visibility.

C#
[Browsable(false)]
public RadElement FillElement { get; }
C#
[Browsable(false)]
public bool ForceViewportHeight { get; set; }
C#
[Browsable(false)]
public bool ForceViewportWidth { get; set; }

Gets the horizontal scrollbar element hosted by the underlying ScrollLayoutPanel.

C#
[Browsable(false)]
public RadScrollBarElement HorizontalScrollBar { get; }
C#
[Browsable(true)]
public ScrollState HorizontalScrollState { get; set; }
C#
[Browsable(true)]
public Point MaxValue { get; }
C#
[Browsable(true)]
public Point MinValue { get; }
C#
[Browsable(true)]
public Point PixelsPerLineScroll { get; set; }

Gets the internal RadScrollLayoutPanel that arranges the viewport and the scrollbars for this scroll viewer.

C#
public RadScrollLayoutPanel ScrollLayoutPanel { get; }
C#
[Browsable(true)]
public int ScrollThickness { get; set; }

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

C#
[Browsable(true)]
public bool ShowBorder { get; set; }

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

C#
[Browsable(true)]
public bool ShowFill { get; set; }
C#
[Browsable(true)]
public bool UsePhysicalScrolling { get; set; }
C#
[Browsable(true)]
public Point Value { get; set; }

Gets the vertical scrollbar element hosted by the underlying ScrollLayoutPanel.

C#
[Browsable(false)]
public RadScrollBarElement VerticalScrollBar { get; }
C#
[Browsable(true)]
public ScrollState VerticalScrollState { get; set; }
C#
[Browsable(false)]
public virtual RadElement Viewport { get; set; }

Gets whether the viewport uses virtualization. The base implementation reports the viewport's Virtualized value when available, and otherwise returns true. A derived viewer must override the setter to support changing this value.

C#
[Browsable(true)]
public virtual bool Virtualized { get; set; }
Exceptions: InvalidOperationException

The base setter is called.

Implements: IScrollViewer.Virtualized

Methods

Creates the layout panel, viewport chrome, and event forwarding used by the viewer.

C#
protected override void CreateChildElements()

Overrides: RadElement.CreateChildElements()

Creates the layout panel that hosts the viewport and scrollbars. Override this method to provide a specialized scroll layout panel.

C#
protected virtual RadScrollLayoutPanel CreateScrollLayoutPanel()
Returns:

RadScrollLayoutPanel

Enables clipping so viewport content outside the viewer's bounds is not painted.

C#
protected override void InitializeFields()

Overrides: RadItem.InitializeFields()

Scrolls down by the viewport's small vertical change.

C#
public void LineDown()

Implements: IScrollViewer.LineDown()

Scrolls left by the viewport's small horizontal change.

C#
public void LineLeft()

Implements: IScrollViewer.LineLeft()

Scrolls right by the viewport's small horizontal change.

C#
public void LineRight()

Implements: IScrollViewer.LineRight()

Scrolls up by the viewport's small vertical change.

C#
public void LineUp()

Implements: IScrollViewer.LineUp()

Measures the viewer and, when content-based viewport sizing is enabled, uses the viewport's desired height.

C#
protected override SizeF MeasureOverride(SizeF availableSize)
Parameters:availableSizeSizeF

The space available for measurement.

Returns:

SizeF

The measured size of the viewer.

Overrides: RadElement.MeasureOverride(SizeF)

Propagates the viewer's minimum and maximum size constraints to its scroll layout panel.

C#
protected override void OnPropertyChanged(RadPropertyChangedEventArgs e)
Parameters:eRadPropertyChangedEventArgs

The property change being processed.

Overrides: RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Raises Scroll after the scroll position changes.

C#
protected virtual void OnScroll(ScrollPanelEventArgs args)
Parameters:argsScrollPanelEventArgs

The previous and new scroll positions.

Raises ScrollNeedsChanged when scrollbar need changes.

C#
protected virtual void OnScrollNeedsChanged(ScrollNeedsEventArgs args)
Parameters:argsScrollNeedsEventArgs

The old and new scrollbar-need states.

Raises ScrollParametersChanged with the updated scrollbar parameters.

C#
protected virtual void OnScrollParametersChanged(RadPanelScrollParametersEventArgs args)
Parameters:argsRadPanelScrollParametersEventArgs

The changed scrollbar parameters and orientation.

Scrolls down by the viewport's large vertical change.

C#
public void PageDown()

Implements: IScrollViewer.PageDown()

Scrolls left within viewport by one page.

C#
public void PageLeft()

Implements: IScrollViewer.PageLeft()

Scrolls right within viewport by one page.

C#
public void PageRight()

Implements: IScrollViewer.PageRight()

Scrolls up by the viewport's large vertical change.

C#
public void PageUp()

Implements: IScrollViewer.PageUp()

Scrolls the viewport by the minimum amount needed to bring the specified element into view.

C#
public void ScrollElementIntoView(RadElement element)
Parameters:elementRadElement

The element to bring into the visible viewport.

Implements: IScrollViewer.ScrollElementIntoView(RadElement)

Moves the vertical scroll position to its last valid value without changing the horizontal position.

C#
public void ScrollToBottom()

Implements: IScrollViewer.ScrollToBottom()

Moves both scroll positions to their last valid values.

C#
public void ScrollToEnd()

Implements: IScrollViewer.ScrollToEnd()

Moves both scroll positions to their first valid values.

C#
public void ScrollToHome()

Implements: IScrollViewer.ScrollToHome()

Moves the horizontal scroll position to its first valid value without changing the vertical position.

C#
public void ScrollToLeftEnd()

Implements: IScrollViewer.ScrollToLeftEnd()

Moves the horizontal scroll position to its last valid value without changing the vertical position.

C#
public void ScrollToRightEnd()

Implements: IScrollViewer.ScrollToRightEnd()

Moves the vertical scroll position to its first valid value without changing the horizontal position.

C#
public void ScrollToTop()

Implements: IScrollViewer.ScrollToTop()

Events

Occurs when the viewport's horizontal or vertical scroll position changes.

C#
public event RadScrollPanelHandler Scroll

Occurs when layout determines that horizontal or vertical scrolling has become needed or is no longer needed.

C#
public event ScrollNeedsHandler ScrollNeedsChanged

Occurs when a scrollbar's scrolling parameters change.

C#
public event RadPanelScrollParametersHandler ScrollParametersChanged