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

Implements the basic functionality for the scrolling.

This class can be used both for horizontal and for vertical scrolling through its property ScrollType. Only the specialized children are put in the Toolbox: RadHScrollBar and RadVScrollBar.

To adjust the value range of the scroll bar control set the Minimum and Maximum properties. To adjust the distance the scroll thumb moves, set the SmallChange and LargeChange properties. To adjust the starting point of the scroll thumb, set the Value property when the control is initially displayed.

Definition

Namespace:Telerik.WinControls.UI

Assembly:Telerik.WinControls.UI.dll

Syntax:

C#
[ComVisible(true)]
public class RadScrollBar : RadControl, IDropTarget, ISynchronizeInvoke, IWin32Window, IBindableComponent, IComponent, IDisposable, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IAnalyticsProvider

Inheritance: objectMarshalByRefObjectComponentControlScrollableControlRadControlRadScrollBar...

Derived Classes: RadHScrollBarRadVScrollBar

Implements: IAnalyticsProviderIBindableComponentIComponentIComponentTreeHandlerIDisposableIDropTargetILayoutHandlerINotifyPropertyChangedISupportInitializeISupportInitializeNotificationISynchronizeInvokeIWin32Window...

Inherited Members RadControl.isResizing2RadControl.isDisposing2RadControl.invalidResizeRectRadControl.isAccessibilityRequestedRadControl.Construct()RadControl.CreateBehavior()RadControl.InitializeRootElement(RootRadElement)RadControl.LoadElementTree()RadControl.LoadElementTree(Size)RadControl.SetBackColorThemeOverrides()RadControl.ResetBackColorThemeOverrides()RadControl.SetForeColorThemeOverrides()RadControl.ResetForeColorThemeOverrides()RadControl.OnKeyDown(KeyEventArgs)RadControl.OnKeyUp(KeyEventArgs)RadControl.OnPreviewKeyDown(PreviewKeyDownEventArgs)RadControl.OnKeyPress(KeyPressEventArgs)RadControl.OnClick(EventArgs)RadControl.OnDoubleClick(EventArgs)RadControl.OnMouseDown(MouseEventArgs)RadControl.OnMouseUp(MouseEventArgs)RadControl.OnMouseEnter(EventArgs)RadControl.OnMouseLeave(EventArgs)RadControl.OnMouseMove(MouseEventArgs)RadControl.OnMouseHover(EventArgs)RadControl.OnMouseWheel(MouseEventArgs)RadControl.OnMouseCaptureChanged(EventArgs)RadControl.OnGotFocus(EventArgs)RadControl.OnLostFocus(EventArgs)RadControl.OnCreateControl()RadControl.OnHandleDestroyed(EventArgs)RadControl.OnParentChanged(EventArgs)RadControl.OnVisibleChanged(EventArgs)RadControl.OnFontChanged(EventArgs)RadControl.OnForeColorChanged(EventArgs)RadControl.OnBackColorChanged(EventArgs)RadControl.OnEnabledChanged(EventArgs)RadControl.OnBindingContextChanged(EventArgs)RadControl.OnLocationChanged(EventArgs)RadControl.OnPaddingChanged(EventArgs)RadControl.OnRightToLeftChanged(EventArgs)RadControl.OnPaint(PaintEventArgs)RadControl.OnLayout(LayoutEventArgs)RadControl.OnAutoSizeChanged(EventArgs)RadControl.WndProc(ref Message)RadControl.OnInvalidated(RadElement)RadControl.OnLoad(Size)RadControl.OnCaptureLosing()RadControl.OnThemeChanged()RadControl.OnToolTipTextNeeded(object, ToolTipTextNeededEventArgs)RadControl.OnScreenTipNeeded(object, ScreenTipNeededEventArgs)RadControl.OnThemeNameChanged(ThemeNameChangedEventArgs)RadControl.ProcessMnemonic(char)RadControl.ProcessFocusRequested(RadElement)RadControl.ProcessCaptureChangeRequested(RadElement, bool)RadControl.ProcessAutoSizeChanged(bool)RadControl.IsInputKey(Keys)RadControl.GetInputElement()RadControl.BeginInit()RadControl.EndInit()RadControl.OnNotifyPropertyChanged(string)RadControl.OnNotifyPropertyChanged(PropertyChangedEventArgs)RadControl.GetPreferredSize(Size)RadControl.SetBoundsCore(int, int, int, int, BoundsSpecified)RadControl.GetRootElementDesiredSize(int, int, int, int)RadControl.OnZoomGesture(ZoomGestureEventArgs)RadControl.OnRotateGesture(RotateGestureEventArgs)RadControl.OnPanGesture(PanGestureEventArgs)RadControl.OnTwoFingerTapGesture(GestureEventArgs)RadControl.OnPressAndTapGesture(PressAndTapGestureEventArgs)RadControl.OnGesture(GestureEventArgs)RadControl.ProcessGesture(Message)RadControl.EnableGesture(GestureType)RadControl.DisableGesture(GestureType)RadControl.Refresh()RadControl.SuspendUpdate()RadControl.ResumeUpdate()RadControl.ResumeUpdate(bool)RadControl.InvokeLayoutCallback(LayoutCallback)RadControl.RegisterHostedControl(RadHostItem)RadControl.UnregisterHostedControl(RadHostItem, bool)RadControl.ResolveStyleGroupForElement(StyleGroup, RadObject)RadControl.GetPlainText()RadControl.ShouldSerializeProperty(RadProperty)RadControl.ShouldSerializeProperty(RadProperty, RadObject)RadControl.ResetProperty(RadProperty, RadObject)RadControl.CanEditElementAtDesignTime(RadElement)RadControl.ProcessCodedUIMessage(ref IPCMessage)RadControl.FindPropertyInChildren(RadControl, IPCMessage)RadControl.ScaleControl(SizeF, BoundsSpecified)RadControl.PerformRadAutoScale(BoundsSpecified?)RadControl.GetMonitorDpiScaleFactor(Control)RadControl.SetRadAutoScale(bool)RadControl.EnableDpiScalingRadControl.EnableRadAutoScaleRadControl.EnableRadFormInitialDpiScalingRadControl.EnableImageDpiScalingRadControl.EnableSvgImagesRadControl.IsLoadedRadControl.ElementTreeRadControl.UseCompatibleTextRenderingDefaultValueRadControl.BehaviorRadControl.RootElementRadControl.PaddingRadControl.ThemeNameRadControl.TextRadControl.EnableThemingRadControl.ImageListRadControl.ImageScalingSizeRadControl.UseCompatibleTextRenderingRadControl.AutoSizeRadControl.MaximumSizeRadControl.MinimumSizeRadControl.FocusableRadControl.SiteRadControl.CausesValidationRadControl.IsInitializingRadControl.SmallImageListRadControl.SmallImageScalingSizeRadControl.IsDesignModeRadControl.IsDisplayedRadControl.FocusedElementRadControl.AllowShowFocusCuesRadControl.ShowItemToolTipsRadControl.CommandBindingsRadControl.EnableKeyMapRadControl.BackColorRadControl.ForeColorRadControl.FontRadControl.ValidationCancelRadControl.EnableAnalyticsRadControl.AnalyticsNameRadControl.EnableRadAccessibilityObjectsRadControl.EnableCodedUITestsRadControl.EnableCodedUITestsDefaultValueRadControl.EnableUIAutomationRadControl.EnableUIAutomationDefaultValueRadControl.ElementInvalidatedRadControl.ToolTipTextNeededRadControl.ScreenTipNeededRadControl.ThemeNameChangedRadControl.InitializedRadControl.PropertyChangedRadControl.ZoomGestureRadControl.RotateGestureRadControl.PanGestureRadControl.TwoFingerTapGestureRadControl.PressAndTapGesture...

Constructors

C#
public RadScrollBar()

Properties

C#
public int LargeChange { get; set; }
C#
public int Maximum { get; set; }
C#
public int Minimum { get; set; }
C#
public int MinThumbLength { get; set; }

Gets the instance of RadScrollBarElement wrapped by this control. RadScrollBarElement is the main element in the hierarchy tree and encapsulates the actual functionality of both RadHScrollBar and RadVScrollBar.

C#
[Browsable(false)]
public RadScrollBarElement ScrollBarElement { get; }
C#
public virtual ScrollType ScrollType { get; set; }
C#
public int SmallChange { get; set; }

Gets the theme class name for this control.

C#
public override string ThemeClassName { get; }

Overrides: RadControl.ThemeClassName

C#
public int ThumbLength { get; }
C#
public double ThumbLengthProportion { get; set; }
C#
public int Value { get; set; }

Methods

Checks whether the element's theme is defined by the control.

C#
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters:elementRadElement

The element to should be checked.

Returns:

bool

true if the control defines theme for this element, false otherwise.

Overrides: RadControl.ControlDefinesThemeForElement(RadElement)

If true is returned the ThemeResolutionService would not not set any theme to the element to avoid duplicating the style settings of the element.

C#
protected override AccessibleObject CreateAccessibilityInstance()
Returns:

AccessibleObject

Overrides: Control.CreateAccessibilityInstance()

C#
protected override void CreateChildItems(RadElement parent)
Parameters:parentRadElement

Overrides: RadControl.CreateChildItems(RadElement)

C#
protected override RootRadElement CreateRootElement()
Returns:

RootRadElement

Overrides: RadControl.CreateRootElement()

C#
protected virtual RadScrollBarElement CreateScrollBarElement()
Returns:

RadScrollBarElement

C#
protected override void Dispose(bool disposing)
Parameters:disposingbool

Overrides: RadControl.Dispose(bool)

C#
protected virtual void OnScrollParameterChanged(EventArgs args)
Parameters:argsEventArgs
C#
protected virtual void OnValueChanged(EventArgs e)
Parameters:eEventArgs

Scrolls to the first position specified by the Minimum property.

C#
public void PerformFirst()

Decrements the thumb position by the number of large steps given as a parameter. The distance of a large step is determined by the LargeChange property.

C#
public void PerformLargeDecrement(int numSteps)
Parameters:numStepsint

Increments the thumb position by the number of large steps given as a parameter. The distance of a large step is determined by the LargeChange property.

C#
public void PerformLargeIncrement(int numSteps)
Parameters:numStepsint

Scrolls to the last position specified by the Maximum property.

C#
public void PerformLast()

Scrolls to the specified position.

C#
public void PerformScrollTo(Point position)
Parameters:positionPoint

Decrements the thumb position by the number of small steps given as a parameter. The distance of a small step is determined by the SmallChange property.

C#
public void PerformSmallDecrement(int numSteps)
Parameters:numStepsint

Increments the thumb position by the number of small steps given as a parameter. The distance of a small step is determined by the SmallChange property.

C#
public void PerformSmallIncrement(int numSteps)
Parameters:numStepsint

Events

C#
public event EventHandler ScrollParameterChanged
C#
public event EventHandler ValueChanged