ScrollBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Implements the basic functionality of a scroll bar control.
- C#
- VB.NET
public abstract class ScrollBar : Control
Public MustInherit Class ScrollBar
Inherits Control
Constructors
ScrollBar()
Initializes a new instance of the ScrollBar class.
Properties
LargeChange
Int32: Returns or sets a value to be added to or subtracted from the Value property when the scroll box is moved a large distance. (Default: 10)
Value: A numeric value. The default value is 10.
Throws:
- ArgumentOutOfRangeException The assigned value is less than 0.
Maximum
Int32: Returns or sets the upper limit of values of the scrollable range. (Default: 100)
Value: A numeric value. The default value is 100.
Minimum
Int32: Returns or sets the lower limit of values of the scrollable range. (Default: 0)
Value: A numeric value. The default value is 0.
Orientation
Orientation: Returns the orientation of the scrollbar control.
SmallChange
Int32: Returns or sets the value to be added to or subtracted from the Value property when the scroll box is moved a small distance. (Default: 1)
Value: A numeric value. The default value is 1.
Throws:
- ArgumentOutOfRangeException The assigned value is less than 0.
TabStop
Boolean: Returns or sets whether the user can give the focus to this control using the TAB key and the Focusable property is set to true. (Default: False)
Value: True if the control can receive the focus using the TAB key. The default is false.
Value
Int32: Returns or sets a numeric value that represents the current position of the scroll box on the scroll bar control. (Default: 0)
Value: A numeric value that is within the Minimum and Maximum range. The default value is 0.
Throws:
- ArgumentOutOfRangeException The assigned value is less than the Minimum property value; or the assigned value is greater than the Maximum property value.
Methods
OnScroll(e)
Fires the Scroll event.
| Parameter | Type | Description |
|---|---|---|
| e | ScrollEventArgs | A ScrollEventArgs that contains the event data. |
OnValueChanged(e)
Fires the ValueChanged event.
OnWebEvent(e)
Processes the event from the client.
| Parameter | Type | Description |
|---|---|---|
| e | WisejEventArgs | Event arguments. |
OnWebRender(config)
Renders the client component.
| Parameter | Type | Description |
|---|---|---|
| config | Object | Dynamic configuration object. |
Events
Scroll
ScrollEventHandler Fired when the scroll box has been moved by either a mouse or keyboard action.
ValueChanged
EventHandler Fired when the Value property is changed, either by a Scroll event or programmatically.
Inherited By
| Name | Description |
|---|---|
| HScrollBar | Represents an horizontal scroll bar. |
| VScrollBar | Represents a vertical scroll bar. |
Implements
| Name | Description |
|---|---|
| IUserData | Provides access to the UserData and Tag properties associated to the component implementing this interface. |
| IBindableComponent | Bindable components implement this interface. |
| IDropTarget | Controls that support drag & drop operations implement this interface. |
| IWisejComponent | All wisej components implement this interface. |
| IWisejControl | All wisej controls derived from the Control class must implement this interface. |
| IWisejSerializable | Allows an object to serialize itself. |