ScrollBar Class
Represents a scrollbar control.
[ToolboxBitmap(typeof(ScrollBar))]
public class ScrollBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, ICommandTarget, IOrientedElement- Inheritance:
- object MarshalByRefObject Component Control ScrollableControl UIControl object
- Implements:
- IUIControl IUIElement ILogicalTreeNode IDpiAwareElement IDisposable ICommandTarget IOrientedElement
Constructors
ScrollBar()
Initializes an instance of the class.
public ScrollBar()Properties
BarrelAfterThumbBounds
The bounds of the barrel after the thumb.
BarrelBeforeThumbBounds
The bounds of the barrel before the thumb.
CommandLinks
A CommandLinkCollection containing the command links associated with the object.
[Browsable(false)]
public CommandLinkCollection CommandLinks { get; }Property Value
CurrentScrollCommand
The current scroll Command that is executing.
DecreaseLargeCommand
The Command that is used for a large decrease button click.
DecreaseSmallCommand
The Command that is used for a small decrease button click.
DefaultSize
Gets the default size of the control.
ForwardCommandsTo
The ICommandTarget to forward commands to.
[Browsable(false)]
public ICommandTarget? ForwardCommandsTo { get; set; }Property Value
IncreaseLargeCommand
The Command that is used for a large increase button click.
IncreaseSmallCommand
The Command that is used for a small increase button click.
LargeChange
The value to be added to or subtracted from to the Value property when the scroll box is moved a large distance.
Maximum
The upper limit of values of the scrollable range.
Minimum
The lower limit of values of the scrollable range.
Orientation
The orientation of the scrollbar.
Renderer
The control-specific IScrollBarRenderer used to render the control.
public IScrollBarRenderer? Renderer { get; set; }Property Value
Remarks
If this value is null, then the global renderer will be used instead.
RendererResolved
The IScrollBarRenderer used to render the control.
[Browsable(false)]
public IScrollBarRenderer RendererResolved { get; }Property Value
Remarks
This property will return a global renderer if there is no control instance renderer override.
The registered renderer type with the UIRendererManager for this property is IScrollBarRenderer.
SmallChange
The value to be added to or subtracted from to the Value property when the scroll box is moved a small distance.
Value
A numeric value that represents the current position of the scroll box on the scroll bar control.
public int Value { get; set; }Property Value
Methods
ArrangeOverride(Size)
Positions child elements and determines an arrange size.
protected override Size ArrangeOverride(Size finalSize)| Parameter | Type | Description |
|---|---|---|
| finalSize | Size | The final area within the parent that this element should use to arrange itself and its children. |
Returns
- Size:
The actual size used.
Remarks
Element authors should override this method, call Arrange(Rectangle) on each visible child element and position each child element. It is required that a parent element calls Arrange(Rectangle) on each child or they won't be rendered.
CreateChildren()
Invoked when the collection of child elements is to be created.
protected override IList<ILogicalTreeNode>? CreateChildren()Returns
- IList<ILogicalTreeNode>:
The list that should be assigned to the Children property.
Remarks
By default, no child collection is created.
Dispose(bool)
Releases the unmanaged resources used by the Control and its child controls and optionally releases the managed resources.
protected override void Dispose(bool disposing)| Parameter | Type | Description |
|---|---|---|
| disposing | bool |
|
GetSidesFromOrientation(Orientation)
Returns the Sides value that corresponds to the specified Orientation.
public static Sides GetSidesFromOrientation(Orientation orientation)| Parameter | Type | Description |
|---|---|---|
| orientation | Orientation | The Orientation to examine. |
Returns
MeasureOverride(Graphics?, Size)
Measures the size in layout required for child elements and determines a size for the element itself.
protected override Size MeasureOverride(Graphics? g, Size availableSize)| Parameter | Type | Description |
|---|---|---|
| g | Graphics | The Graphics object to use for measurement. |
| availableSize | Size | The available size that this element can give to child elements. Infinity can be specified as a value to indicate that the element will size to whatever content is available. |
Returns
- Size:
The size that this element determines it needs during layout, based on its calculations of child element sizes.
Remarks
Element authors should override this method, call Measure(Graphics?, Size) on each visible child element and determine the total size required.
OnCommand(CommandEventArgs)
Raises the Command event.
protected virtual void OnCommand(CommandEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | CommandEventArgs | The event data. |
OnEnabledChanged(EventArgs)
Raises the EnabledChanged event.
protected override void OnEnabledChanged(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | An EventArgs that contains the event data. |
OnMouseDown(MouseEventArgs)
Raises the MouseDown event.
protected override void OnMouseDown(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnMouseUp(MouseEventArgs)
Raises the MouseUp event.
protected override void OnMouseUp(MouseEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | MouseEventArgs | A MouseEventArgs that contains the event data. |
OnRender(PaintEventArgs)
Renders the element.
protected override void OnRender(PaintEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | PaintEventArgs | The event data. |
OnScrolled(ScrollEventArgs)
Raises the Scrolled event.
protected virtual void OnScrolled(ScrollEventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | ScrollEventArgs | The event data. |
OnThumbScrolled(EventArgs)
Raises the ThumbScrolled event.
protected virtual void OnThumbScrolled(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnThumbScrolling(EventArgs)
Raises the ThumbScrolling event.
protected virtual void OnThumbScrolling(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
OnValueChanged(EventArgs)
Raises the ValueChanged event.
protected virtual void OnValueChanged(EventArgs e)| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | The event data. |
RaiseCommand(Command)
Raises the specified Command.
public virtual bool RaiseCommand(Command command)| Parameter | Type | Description |
|---|---|---|
| command | Command | The Command to raise. |
Returns
SetData(int, int, int, int, bool)
Sets all the data in one consolidated method.
public void SetData(int minimum, int maximum, int smallChange, int largeChange, bool enabled)| Parameter | Type | Description |
|---|---|---|
| minimum | int | The minimum. |
| maximum | int | The maximum. |
| smallChange | int | The small change. |
| largeChange | int | The large change. |
| enabled | bool | Whether the control is enabled. |
Events
Command
Occurs when a Command is executed.
Scrolled
Occurs after a scroll event occurs.
ThumbScrolled
Occurs after thumb scrolling ends.
ThumbScrolling
Occurs before thumb scrolling starts.
ValueChanged
Occurs after the value of the Value property changes.
Inherited Members
- UIControl.AddPendingGraphicsInversion(Rectangle)
- UIControl.AddPendingScrollOperation(Rectangle, Orientation, int)
- UIControl.AddPendingScrollOperation(Rectangle, int, int)
- UIControl.AddToInvalidatedRegion()
- UIControl.AddToInvalidatedRegion(Rectangle)
- UIControl.Arrange(Rectangle)
- UIControl.ContainsLocation(Point)
- UIControl.DpiScaleChanged(SizeF)
- UIControl.GetCursor(Point)
- UIControl.HitTest(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.HitTestRecursive(PointHitTestParameters, Func<IUIElement, PointHitTestParameters, bool>)
- UIControl.Invalidate(InvalidationLevels, InvalidationTypes)
- UIControl.InvalidateArrange()
- UIControl.InvalidateMeasure()
- UIControl.Measure(Graphics, Size)
- UIControl.OnClick(EventArgs)
- UIControl.OnDoubleClick(EventArgs)
- UIControl.OnDpiChangedAfterParent(EventArgs)
- UIControl.OnHandleCreated(EventArgs)
- UIControl.OnLayout(LayoutEventArgs)
- UIControl.OnLocationChanged(EventArgs)
- UIControl.OnMouseCaptureChanged(EventArgs)
- UIControl.OnMouseEnter(EventArgs)
- UIControl.OnMouseHover(EventArgs)
- UIControl.OnMouseLeave(EventArgs)
- UIControl.OnMouseMove(MouseEventArgs)
- UIControl.OnMouseWheel(MouseEventArgs)
- UIControl.OnPaint(PaintEventArgs)
- UIControl.OnPaintBackground(PaintEventArgs)
- UIControl.OnParentChanged()
- UIControl.OnParentChanged(EventArgs)
- UIControl.OnRenderChildElements(PaintEventArgs)
- UIControl.OnResize(EventArgs)
- UIControl.OnRightToLeftChanged(EventArgs)
- UIControl.OnVisibleChanged(EventArgs)
- UIControl.Render(PaintEventArgs)
- UIControl.ResetDoubleBufferCanvas(bool)
- UIControl.ResumePainting()
- UIControl.SuspendPainting()
- UIControl.TransformToAncestor(IUIElement)
- UIControl.TransformToDescendant(IUIElement)
- UIControl.UpdateCursor()
- UIControl.UpdateCursor(Point)
- UIControl.UpdateLayout()
- UIControl.ActualHeight
- UIControl.ActualWidth
- UIControl.BackColor
- UIControl.BackgroundImage
- UIControl.CaptureMouseWhenPressed
- UIControl.ClipBounds
- UIControl.DesiredSize
- UIControl.DpiScaleFactor
- UIControl.Font
- UIControl.ForeColor
- UIControl.IsArrangeValid
- UIControl.IsMeasureValid
- UIControl.IsPaintValid
- UIControl.IsRightToLeft
- UIControl.LastMouseUpButton
- UIControl.PaintingSuspended
- UIControl.UseControlGraphicsForMeasure
- UIControl.UseExtendedDoubleBuffering
- MarshalByRefObject.GetLifetimeService()
- MarshalByRefObject.InitializeLifetimeService()
- MarshalByRefObject.MemberwiseClone(bool)
- object.GetType()
- object.MemberwiseClone()
- object.ToString()
- object.Equals(object)
- object.Equals(object, object)
- object.ReferenceEquals(object, object)
- object.GetHashCode()
Extension Methods
- DpiAwareElementExtensions.AutoScaleFont(IDpiAwareElement, Font)
- DpiAwareElementExtensions.AutoScaleFontSize(IDpiAwareElement, float)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, Padding)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, Point)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, Rectangle)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, Size)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, SizeF)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, int)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, float)
- DpiAwareElementExtensions.ScaleLogicalValue(IDpiAwareElement, Padding)
- DpiAwareElementExtensions.SynchronizeScaleFactorWithChildren(IDpiAwareElement)
- OrientedElementExtensions.CreatePoint(IOrientedElement, int, int)
- OrientedElementExtensions.CreateRect(IOrientedElement, int, int, int, int)
- OrientedElementExtensions.CreateSize(IOrientedElement, int, int)
- OrientedElementExtensions.GetLocationAscent(IOrientedElement, Point)
- OrientedElementExtensions.GetLocationAscent(IOrientedElement, Rectangle)
- OrientedElementExtensions.GetLocationExtent(IOrientedElement, Point)
- OrientedElementExtensions.GetLocationExtent(IOrientedElement, Rectangle)
- OrientedElementExtensions.GetOrientedValue<T>(IOrientedElement, Func<T>, Func<T>)
- OrientedElementExtensions.GetOrientedValue<T>(IOrientedElement, T, T)
- OrientedElementExtensions.GetPoint(IOrientedElement, int, int)
- OrientedElementExtensions.GetSizeAscent(IOrientedElement, Rectangle)
- OrientedElementExtensions.GetSizeAscent(IOrientedElement, Size)
- OrientedElementExtensions.GetSizeExtent(IOrientedElement, Rectangle)
- OrientedElementExtensions.GetSizeExtent(IOrientedElement, Size)
- OrientedElementExtensions.PerformOrientedAction(IOrientedElement, Action, Action)
- ILogicalTreeNodeExtensions.FindCommonLogicalAncestor(ILogicalTreeNode, ILogicalTreeNode)
- ILogicalTreeNodeExtensions.FindLogicalAncestorOfType<T>(ILogicalTreeNode, bool)
- ILogicalTreeNodeExtensions.FindLogicalDescendantOfType<T>(ILogicalTreeNode, bool)
- ILogicalTreeNodeExtensions.GetLogicalAncestors(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetLogicalChildren(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetLogicalDescendants(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetLogicalParent(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetLogicalParent<T>(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetLogicalSiblings(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetSelfAndLogicalAncestors(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.GetSelfAndLogicalDescendants(ILogicalTreeNode)
- ILogicalTreeNodeExtensions.IsLogicalAncestorOf(ILogicalTreeNode, ILogicalTreeNode)
- ObjectExtensions.TryConvertToDouble(object, out double)
- ObjectExtensions.TryConvertToDouble(object, IFormatProvider, out double)
- ControlExtensions.FindAncestorOfType<T>(Control, bool)
- ControlExtensions.FindCommonAncestor(Control, Control)
- ControlExtensions.FindDescendantOfType<T>(Control, bool)
- ControlExtensions.GetAncestors(Control)
- ControlExtensions.GetChildren(Control)
- ControlExtensions.GetDescendants(Control)
- ControlExtensions.GetParent(Control)
- ControlExtensions.GetParent<T>(Control)
- ControlExtensions.GetSelfAndAncestors(Control)
- ControlExtensions.GetSelfAndDescendants(Control)
- ControlExtensions.GetSiblings(Control)
- ControlExtensions.IsAncestorOf(Control, ILogicalTreeNode)
- ControlExtensions.IsAncestorOf(Control, Control)