SlideBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.1.0.0)
Displays child controls vertically or horizontally in a scrollable container.
- C#
- VB.NET
public class SlideBar : Control
Public Class SlideBar
Inherits Control
Constructors
SlideBar()
Initializes a new instance of the SlideBar class.
SlideBar(controls, orientation)
Initializes a new instance of the SlideBar class with the specified settings.
| Name | Type | Description |
|---|---|---|
| controls | Control[] | An array of Control objects to be added to the panel. |
| orientation | Orientation | Initial Orientation value. |
SlideBar(location, size, controls, orientation)
Initializes a new instance of the SlideBar class with the specified settings.
| Name | Type | Description |
|---|---|---|
| location | Point | The location of the panel on its parent control. |
| size | Size | The size of the panel. |
| controls | Control[] | An array of Control objects to be added to the panel. |
| orientation | Orientation | Initial Orientation value. |
Properties
BorderStyle
BorderStyle: Returns or sets the type of border that is drawn around the SlideBar control. (Default: None)
ButtonsBackColor
Color: Returns or sets the background Color of the scroll buttons.
The default background color is set in the theme color as "slidebarButtons".
HorizontalScroll
HScrollProperties: Returns the properties associated with the horizontal scroll position.
HScroll
Boolean: Returns whether the horizontal scroll buttons are visible.
LayoutEngine
LayoutEngine: Returns the control's layout engine.
Orientation
Orientation: Returns or sets the Orientation of the SlideBar control. (Default: Horizontal)
ScrollStep
Int32: Returns or sets the number of pixels to scroll when the scroll buttons are pressed. (Default: 15)
Throws:
- ArgumentOutOfRangeException The value is less than 1 or greater than 32000.
Spacing
Int32: Returns or sets the spacing between the child controls. (Default: 0)
Throws:
- ArgumentOutOfRangeException The value is less than 0 or greater than 32000.
VerticalScroll
VScrollProperties: Returns the properties associated with the vertical scroll position.
VScroll
Boolean: Returns whether the vertical scroll buttons are visible.
Methods
OnControlAdded(e)
Fires the ControlAdded event.
| Parameter | Type | Description |
|---|---|---|
| e | ControlEventArgs | A ControlEventArgs that contains the event data. |
OnOrientationChanged(e)
Fires the OrientationChanged event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | A EventArgs that contains the event data. |
OnScroll(e)
Fires the Scroll event.
| Parameter | Type | Description |
|---|---|---|
| e | ScrollEventArgs | A ScrollEventArgs that contains the event data. |
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
OnScrollAnimationEnd(e)
Fires the ScrollAnimationEnd event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | A EventArgs that contains the event data. |
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
OnScrollStepChanged(e)
Fires the ScrollStepChanged event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | A EventArgs that contains the event data. |
OnSpacingChanged(e)
Fires the SpacingChanged event.
| Parameter | Type | Description |
|---|---|---|
| e | EventArgs | A EventArgs that contains the event data. |
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. |
OnWebUpdate(state)
Updates the client component using the state information.
| Parameter | Type | Description |
|---|---|---|
| state | Object | Dynamic state object. |
ScrollBy(offset, duration)
Scrolls the content by the specified offset in pixels.
| Parameter | Type | Description |
|---|---|---|
| offset | Int32 | Number of pixels to scroll by. |
| duration | Int32 | The time in milliseconds the scroll to should take. |
ScrollControlIntoView(control)
Scrolls the specified child control into view.
| Parameter | Type | Description |
|---|---|---|
| control | Control | The child control to scroll into view. |
ScrollControlIntoView(control, alignX)
Scrolls the specified child control into view. using the specified alignX preference.
| Parameter | Type | Description |
|---|---|---|
| control | Control | The child control to scroll into view. |
| alignX | HorizontalAlignment | Indicates the HorizontalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Center will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement. |
ScrollControlIntoView(control, alignY)
Scrolls the specified child control into view. using the specified alignY preference.
| Parameter | Type | Description |
|---|---|---|
| control | Control | The child control to scroll into view. |
| alignY | VerticalAlignment | Indicates the VerticalAlignment preference. The final location of the control depends on the scrollable range and the available space. Note that Middle will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement. |
ScrollTo(position, duration)
Scrolls the content to the specified position in pixels.
| Parameter | Type | Description |
|---|---|---|
| position | Int32 | The position in pixels to scroll to. |
| duration | Int32 | The time in milliseconds the scroll to should take. |
Events
OrientationChanged
EventHandler Fired when the value of Orientation changes.
Scroll
ScrollEventHandler Fired when the SlideBar widget scrolls its content.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
ScrollAnimationEnd
EventHandler Fired when the control has completed the scrolling animation.
This event fires only if there is an handler attached to it. A simple overload of the On[Event] method in a derived class will not be invoked unless there is at least one handler attached to the event.
ScrollStepChanged
EventHandler Fired when the value of ScrollStep changes.
SpacingChanged
EventHandler Fired when the value of Spacing changes.
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. |