Class

RadScrollBarElement

Declaration

public RadScrollBarElement()

Declaration

public const ScrollType DefaultScrollType = Horizontal

Field Value

Identifies the GradientAngleCorrection dependency property.

Declaration

public static readonly RadProperty GradientAngleCorrectionProperty

Field Value

Gets or sets the default height for horizontal scroll bars.

Declaration

public static int HorizontalScrollBarHeight

Field Value

Identifies the IsMouseOverScrollBar dependency property.

Declaration

public static readonly RadProperty IsMouseOverScrollBarProperty

Field Value

Identifies the MinThumbLength dependency property.

Declaration

public static readonly RadProperty MinThumbLengthProperty

Field Value

Identifies the Pressed dependency property.

Declaration

public static readonly RadProperty PressedProperty

Field Value

Identifies the ScrollType dependency property.

Declaration

public static readonly RadProperty ScrollTypeProperty

Field Value

Identifies the ThumbLengthProportion dependency property.

Declaration

public static readonly RadProperty ThumbLengthProportionProperty

Field Value

Gets or sets the default width for vertical scroll bars.

Declaration

public static int VerticalScrollBarWidth

Field Value

Declaration

public BorderPrimitive BorderElement { get; }

Property Value

Indicates whether invalid values should be clamped or an exception should be thrown

Declaration

public bool ClampValue { get; set; }

Property Value

Declaration

public FillPrimitive FillElement { get; }

Property Value

Gets the first button element of this scrollbar

Declaration

public ScrollBarButton FirstButton { get; }

Property Value

Controls the angle that the fill primitive will be rotated when switching from horizontal to vertical orientation

Declaration

public float GradientAngleCorrection { get; set; }

Property Value

Gets or sets a value to be added to or subtracted from the Value property when the scroll thumb is moved a large distance.

Declaration

public int LargeChange { get; set; }

Property Value

Remarks

Gets or sets the upper limit of the scrollable range.

Declaration

public int Maximum { get; set; }

Property Value

Remarks

Gets or sets the minimum length of the scrolling thumb. See ThumbLength for more information about thumb length.

Declaration

public int MinThumbLength { get; set; }

Property Value

Gets or sets the lower limit for the values of the scrollable range.

Declaration

public int Minimum { get; set; }

Property Value

Gets or sets the scroll timer delay

Declaration

[Browsable(false)]
public int ScrollTimerDelay { get; set; }

Property Value

Gets or sets the ScrollType - it could be horizontal or vertical.

Declaration

public ScrollType ScrollType { get; set; }

Property Value

Gets the second button element of this scrollbar

Declaration

public ScrollBarButton SecondButton { get; }

Property Value

Gets or sets the value to be added to or subtracted from the Value property when the scroll thumb is moved a small distance.

Declaration

public int SmallChange { get; set; }

Property Value

Remarks

Gets the thumb element of this scrollbar

Declaration

[Browsable(false)]
public ScrollBarThumb ThumbElement { get; }

Property Value

Gets the length of the scrolling thumb. Thumb length is the thumb's height for vertical scroll bar and the thumb's width for horizontal scroll bar.

Declaration

public int ThumbLength { get; }

Property Value

Gets or sets a value between 0.0 and 1.0 that indicates what part of the scrollable area can be occupied by the thumb. If the value is 0.0 then the thumb should be with length 0 but the property MinThumbLength will cause the thumb to be larger. If the value is 1.0 the thumb takes the whole area between the two scrolling buttons. Negative value means that the thumb length should be calculated automatically based on Minimum, Maximum and LargeChange values.

Declaration

public double ThumbLengthProportion { get; set; }

Property Value

Gets or sets a numeric value that represents the current position of the scroll thumb on the scroll bar.

Declaration

public int Value { get; set; }

Property Value

Arranges the RadElement to its final location. The element must call the Arrange method of each of its children.

Declaration

protected override SizeF ArrangeOverride(SizeF finalSize)

Parameters

Returns

Overrides RadElement.ArrangeOverride(SizeF)

Remarks

Called by the element when constructed. Allows inheritors to build the element tree.

Declaration

protected override void CreateChildElements()

Overrides RadElement.CreateChildElements()

Releases managed resources used by this element.

Declaration

protected override void DisposeManagedResources()

Overrides RadItem.DisposeManagedResources()

Retrieves the srolling parameters.

Declaration

public ScrollBarParameters GetParameters()

Returns

Gets the Vista visual style element for this scroll bar.

Declaration

public override VisualStyleElement GetVistaVisualStyle()

Returns

Overrides RadElement.GetVistaVisualStyle()

Gets the XP visual style element for this scroll bar.

Declaration

public override VisualStyleElement GetXPVisualStyle()

Returns

Overrides RadElement.GetXPVisualStyle()

Initializes the fields of this instance with their default values.

Declaration

protected override void InitializeFields()

Overrides RadItem.InitializeFields()

Performs initialization when the element is first-time painted using system skin.

Declaration

protected override void InitializeSystemSkinPaint()

Overrides RadElement.InitializeSystemSkinPaint()

Measures the space required by the RadElement

Used by the layout system.

Declaration

protected override SizeF MeasureOverride(SizeF availableSize)

Parameters

Returns

Overrides RadElement.MeasureOverride(SizeF)

Remarks

Called when the element has been successfully loaded. That includes loading of all its children as well.

Declaration

protected override void OnLoaded()

Overrides RadElement.OnLoaded()

Called when a mouse button is pressed down over the item.

Declaration

protected override void OnMouseDown(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseDown(MouseEventArgs)

Declaration

protected override void OnMouseLeave(EventArgs e)

Parameters

Overrides RadItem.OnMouseLeave(EventArgs)

Called when a mouse button is released over the item.

Declaration

protected override void OnMouseUp(MouseEventArgs e)

Parameters

Overrides RadItem.OnMouseUp(MouseEventArgs)

Fires the PanGesture event.

Declaration

protected override void OnPanGesture(PanGestureEventArgs args)

Parameters

Overrides RadItem.OnPanGesture(PanGestureEventArgs)

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

Overrides RadItem.OnPropertyChanged(RadPropertyChangedEventArgs)

Declaration

protected virtual void OnScroll(ScrollEventArgs args)

Parameters

Declaration

protected virtual void OnScrollParameterChanged()

Declaration

protected virtual void OnValueChanged()

Declaration

protected virtual void OnValueChanged(int oldValue, int newValue)

Parameters

Provides a routine to paint element's content when system skin appearance is desired.

Declaration

protected override void PaintElementSkin(IGraphics graphics)

Parameters

Overrides RadElement.PaintElementSkin(IGraphics)

Declaration

protected virtual void PaintHorizontalVisualStylesElements()

Declaration

protected virtual void PaintVerticalVisualStyleElements()

Declaration

protected virtual void PaintVisualStyleElement(Graphics graphics, VisualStyleElement element, Rectangle bounds)

Parameters

Simulate scrolling with positioning the thumb on its first position. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformFirst()

Simulate scrolling - just like the top / left area according the thumb is pressed. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformLargeDecrement(int numSteps)

Parameters

Simulate scrolling - just like the bottom / right area according the thumb is pressed. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformLargeIncrement(int numSteps)

Parameters

Simulate scrolling with positioning the thumb on its last position. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformLast()

Scrolls just like the thumb is dragged at given position

Declaration

public void PerformScrollTo(Point position)

Parameters

Simulate scrolling - just like the top / left button is pressed. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformSmallDecrement(int numSteps)

Parameters

Simulate scrolling - just like the bottom / right button is pressed. Unlike setting property Value this function fires scrolling events.

Declaration

public void PerformSmallIncrement(int numSteps)

Parameters

Sets the given scroll parameters.

Declaration

public void SetParameters(ScrollBarParameters parameters)

Parameters

Declaration

protected override bool ShouldPaintChild(RadElement element)

Parameters

Returns

Overrides RadElement.ShouldPaintChild(RadElement)

Performs cleanup when system skin painting is no longer used.

Declaration

protected override void UnitializeSystemSkinPaint()

Overrides RadElement.UnitializeSystemSkinPaint()

Occurs when the scroll thumb has been moved by either a mouse or keyboard action.

Declaration

public event ScrollEventHandler Scroll

Event Value

Occurs when a property that affects the scrolling is changed. See ScrollBarParameters for more information on which properties affect the scrolling.

Declaration

public event EventHandler ScrollParameterChanged

Event Value

Occurs when the Value property is changed, either by a Scroll event or programmatically.

Declaration

public event EventHandler ValueChanged

Event Value