ScrollBar Class

[ToolboxBitmap(typeof(ScrollBar))]
public class ScrollBar : UIControl, IUIControl, IUIElement, ILogicalTreeNode, IDpiAwareElement, IDisposable, ICommandTarget, IOrientedElement

public ScrollBar()

Remarks

The default constructor initializes all fields to their default values.

[Browsable(false)]
public Rectangle BarrelAfterThumbBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the bounds of the barrel after the thumb.

[Browsable(false)]
public Rectangle BarrelBeforeThumbBounds { get; }

Property Value

Rectangle:

A Rectangle specifying the bounds of the barrel before the thumb.

[Browsable(false)]
public CommandLinkCollection CommandLinks { get; }

Property Value

CommandLinkCollection:

A CommandLinkCollection containing the command links associated with the object.

[Browsable(false)]
public Command CurrentScrollCommand { get; }

Property Value

Command:

The current scroll Command that is executing.

[Browsable(false)]
public Command DecreaseLargeCommand { get; }

Property Value

Command:

The Command that is used for a large decrease button click.

[Browsable(false)]
public Command DecreaseSmallCommand { get; }

Property Value

Command:

The Command that is used for a small decrease button click.

protected override Size DefaultSize { get; }

Property Value

Size:

The default Size of the control.

[Browsable(false)]
public ICommandTarget ForwardCommandsTo { get; set; }

Property Value

ICommandTarget:

The ICommandTarget to forward commands to.

[Browsable(false)]
public Command IncreaseLargeCommand { get; }

Property Value

Command:

The Command that is used for a large increase button click.

[Browsable(false)]
public Command IncreaseSmallCommand { get; }

Property Value

Command:

The Command that is used for a small increase button click.

public int LargeChange { get; set; }

Property Value

int:

A numeric value. The default value is 10.

public int Maximum { get; set; }

Property Value

int:

A numeric value. The default value is 100.

public int Minimum { get; set; }

Property Value

int:

A numeric value. The default value is 0.

public Orientation Orientation { get; set; }

Property Value

Orientation:

A Orientation that specifies the orientation.

public IScrollBarRenderer Renderer { get; set; }

Property Value

IScrollBarRenderer:

The control-specific IScrollBarRenderer used to render the control.

Remarks

If this value is null, then the global renderer will be used instead.

[Browsable(false)]
public IScrollBarRenderer RendererResolved { get; }

Property Value

IScrollBarRenderer:

The IScrollBarRenderer used to render the control.

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.

public int SmallChange { get; set; }

Property Value

int:

A numeric value. The default value is 1.

public int Value { get; set; }

Property Value

int:

A numeric value that is within the Minimum and Maximum range. The default value is 0.

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.

protected override IList CreateChildren()

Returns

IList:

The IList that should be assigned to the Children property.

Remarks

By default no child collection is created.

protected override void Dispose(bool disposing)

Parameter	Type	Description
disposing	bool	true to release both managed and unmanaged resources; false to release only unmanaged resources.

Remarks

This method is called by the public Dispose method and the Finalize method. Dispose invokes this method with the disposing parameter set to true. Finalize invokes this method with disposing set to false.

public static Sides GetSidesFromOrientation(Orientation orientation)

Parameter	Type	Description
orientation	Orientation	The Orientation to examine.

Returns

Sides:

The Sides value that corresponds to the specified Orientation.

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.

protected virtual void OnCommand(CommandEventArgs e)

Parameter	Type	Description
e	CommandEventArgs	A CommandEventArgs that contains the event data.

protected override void OnEnabledChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected override void OnMouseDown(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnMouseUp(MouseEventArgs e)

Parameter	Type	Description
e	MouseEventArgs	A MouseEventArgs that contains the event data.

protected override void OnRender(PaintEventArgs e)

Parameter	Type	Description
e	PaintEventArgs	A PaintEventArgs that contains the event data.

protected virtual void OnScrolled(ScrollEventArgs e)

Parameter	Type	Description
e	ScrollEventArgs	A ScrollEventArgs that contains the event data.

protected virtual void OnThumbScrolled(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnThumbScrolling(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

protected virtual void OnValueChanged(EventArgs e)

Parameter	Type	Description
e	EventArgs	An EventArgs that contains the event data.

public virtual bool RaiseCommand(Command command)

Parameter	Type	Description
command	Command	The Command to raise.

Returns

bool:

true if the Command was handled; otherwise, false.

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.

public event CommandEventHandler Command

Event Type

CommandEventHandler

public event ScrollEventHandler Scrolled

Event Type

ScrollEventHandler

public event EventHandler ThumbScrolled

Event Type

EventHandler

public event EventHandler ThumbScrolling

Event Type

EventHandler

public event EventHandler ValueChanged

Event Type

EventHandler