Documentation

Class RadScrollBar

Implements the basic functionality for the scrolling.

Inheritance
System.Object
RadControl
RadScrollBar
RadHScrollBar
RadVScrollBar
Inherited Members
Namespace: Telerik.WinControls.UI
Assembly: Telerik.WinControls.UI.dll

Syntax

[ComVisible(true)]
public class RadScrollBar : RadControl, INotifyPropertyChanged, ISupportInitializeNotification, ISupportInitialize, IComponentTreeHandler, ILayoutHandler, IPCHost, IAnalyticsProvider
Remarks

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.

Constructors

RadScrollBar()

Declaration
public RadScrollBar()

Properties

AutoSize

Gets or sets whether the edit control is auto-sized

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

Overrides

BackColor

RadScrollBar consists of multiple visual elements and separate settings are provided to customize their appearance. Current BackColor property might be ignored.

Declaration
public override Color BackColor { get; set; }
Property Value
System.Drawing.Color

Overrides

ForeColor

RadScrollBar consists of multiple visual elements and separate settings are provided to customize their appearance. Current ForeColor property might be ignored.

Declaration
public override Color ForeColor { get; set; }
Property Value
System.Drawing.Color

Overrides

LargeChange

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

Maximum

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

Minimum

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

MinThumbLength

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

ScrollBarElement

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.

Declaration
public RadScrollBarElement ScrollBarElement { get; }
Property Value
RadScrollBarElement

ScrollType

Declaration
[RadDefaultValue("ScrollType", typeof(RadScrollBarElement))]
[RadDescription("ScrollType", typeof(RadScrollBarElement))]
public virtual ScrollType ScrollType { get; set; }
Property Value
ScrollType

SmallChange

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

Text

This property is not relevant for this class.

Declaration
public override string Text { get; set; }
Property Value
System.String

Overrides

ThemeClassName

Declaration
public override string ThemeClassName { get; }
Property Value
System.String

Overrides

ThumbLength

Declaration
[RadDescription("ThumbLength", typeof(RadScrollBarElement))]
public int ThumbLength { get; }
Property Value
System.Int32

ThumbLengthProportion

Declaration
[RadDefaultValue("ThumbLengthProportion", typeof(RadScrollBarElement))]
[RadDescription("ThumbLengthProportion", typeof(RadScrollBarElement))]
public double ThumbLengthProportion { get; set; }
Property Value
System.Double

Value

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

Methods

ControlDefinesThemeForElement(RadElement)

Declaration
public override bool ControlDefinesThemeForElement(RadElement element)
Parameters
RadElement element

Returns
System.Boolean

Overrides

CreateAccessibilityInstance()

Declaration
protected override AccessibleObject CreateAccessibilityInstance()
Returns
System.Windows.Forms.AccessibleObject

CreateChildItems(RadElement)

Declaration
protected override void CreateChildItems(RadElement parent)
Parameters
RadElement parent

Overrides

CreateRootElement()

Declaration
protected override RootRadElement CreateRootElement()
Returns
RootRadElement

Overrides

CreateScrollBarElement()

Declaration
protected virtual RadScrollBarElement CreateScrollBarElement()
Returns
RadScrollBarElement

Dispose(Boolean)

Declaration
protected override void Dispose(bool disposing)
Parameters
System.Boolean disposing

Overrides

OnScrollParameterChanged(EventArgs)

Declaration
protected virtual void OnScrollParameterChanged(EventArgs args)
Parameters
System.EventArgs args

OnValueChanged(EventArgs)

Declaration
protected virtual void OnValueChanged(EventArgs e)
Parameters
System.EventArgs e

PerformFirst()

Scrolls to the first position specified by the Minimum property.

Declaration
public void PerformFirst()

PerformLargeDecrement(Int32)

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.

Declaration
public void PerformLargeDecrement(int numSteps)
Parameters
System.Int32 numSteps

PerformLargeIncrement(Int32)

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.

Declaration
public void PerformLargeIncrement(int numSteps)
Parameters
System.Int32 numSteps

PerformLast()

Scrolls to the last position specified by the Maximum property.

Declaration
public void PerformLast()

PerformScrollTo(Point)

Scrolls to the specified position.

Declaration
public void PerformScrollTo(Point position)
Parameters
System.Drawing.Point position

PerformSmallDecrement(Int32)

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.

Declaration
public void PerformSmallDecrement(int numSteps)
Parameters
System.Int32 numSteps

PerformSmallIncrement(Int32)

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.

Declaration
public void PerformSmallIncrement(int numSteps)
Parameters
System.Int32 numSteps

Events

ScrollParameterChanged

Declaration
[RadDescription("ScrollParameterChanged", typeof(RadScrollBarElement))]
public event EventHandler ScrollParameterChanged
Event Type
System.EventHandler

ValueChanged

Declaration
[RadDescription("ValueChanged", typeof(RadScrollBarElement))]
public event EventHandler ValueChanged
Event Type
System.EventHandler

Extension Methods