# SlideBar Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (4.0.0.0) * [Control](https://docs.wisej.com/api/wisej.web/general/control) * [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) Displays child controls vertically or horizontally in a scrollable container. {% tabs %} {% tab title="C#" %} ```csharp public class SlideBar : Control ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class SlideBar Inherits Control ``` {% endtab %} {% endtabs %} ## Constructors ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SlideBar() Initializes a new instance of the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) class. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SlideBar(controls, orientation) Initializes a new instance of the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) class with the specified settings. | Name | Type | Description | | --------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | **controls** | [Control\[\]](https://docs.wisej.com/api/wisej.web/general/control) | An array of [Control](https://docs.wisej.com/api/wisej.web/general/control) objects to be added to the panel. | | **orientation** | [Orientation](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.orientation) | Initial [Orientation](#orientation) value. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SlideBar(location, size, controls, orientation) Initializes a new instance of the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) class with the specified settings. | Name | Type | Description | | --------------- | -------------------------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------- | | **location** | [Point](https://docs.microsoft.com/dotnet/api/system.drawing.point) | The location of the panel on its parent control. | | **size** | [Size](https://docs.microsoft.com/dotnet/api/system.drawing.size) | The size of the panel. | | **controls** | [Control\[\]](https://docs.wisej.com/api/wisej.web/general/control) | An array of [Control](https://docs.wisej.com/api/wisej.web/general/control) objects to be added to the panel. | | **orientation** | [Orientation](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.orientation) | Initial [Orientation](#orientation) value. | ## Properties ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) BorderStyle [BorderStyle](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.borderstyle): Returns or sets the type of border that is drawn around the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) control. (Default: `None`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ButtonsBackColor [Color](https://docs.microsoft.com/dotnet/api/system.drawing.color): Returns or sets the background [Color](https://docs.microsoft.com/dotnet/api/system.drawing.color) of the scroll buttons. The default background color is set in the theme color as "slidebarButtons". ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) HorizontalScroll [HScrollProperties](https://docs.wisej.com/api/wisej.web/content/scrollbar/wisej.web.hscrollproperties): Returns the properties associated with the horizontal scroll position. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) HScroll [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns whether the horizontal scroll buttons are visible. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) LayoutEngine [LayoutEngine](https://github.com/iceteagroup/wisej-docs-api/blob/v4.0/wisej.web.layout/containers/layoutengine/layoutengine/README.md): Returns the control's layout engine. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Orientation [Orientation](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.orientation): Returns or sets the [Orientation](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.orientation) of the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.slidebar) control. (Default: `Horizontal`) ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollStep [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the number of pixels to scroll when the scroll buttons are pressed. (Default: `15`) **Throws:** * [ArgumentOutOfRangeException](https://docs.microsoft.com/dotnet/api/system.argumentoutofrangeexception) The value is less than 1 or greater than 32000. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Spacing [Int32](https://docs.microsoft.com/dotnet/api/system.int32): Returns or sets the spacing between the child controls. (Default: `0`) **Throws:** * [ArgumentOutOfRangeException](https://docs.microsoft.com/dotnet/api/system.argumentoutofrangeexception) The value is less than 0 or greater than 32000. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) VerticalScroll [VScrollProperties](https://docs.wisej.com/api/wisej.web/content/scrollbar/wisej.web.vscrollproperties): Returns the properties associated with the vertical scroll position. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) VScroll [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean): Returns whether the vertical scroll buttons are visible. ## Methods ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnControlAdded(e) Fires the [ControlAdded](https://docs.wisej.com/api/general/control#controladded) event. | Parameter | Type | Description | | --------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **e** | [ControlEventArgs](https://docs.wisej.com/api/wisej.web/general/control/wisej.web.controleventargs) | A [ControlEventArgs](https://docs.wisej.com/api/wisej.web/general/control/wisej.web.controleventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnOrientationChanged(e) Fires the [OrientationChanged](#orientationchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnScroll(e) Fires the [Scroll](#scroll) event. | Parameter | Type | Description | | --------- | --------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------- | | **e** | [ScrollEventArgs](https://docs.wisej.com/api/wisej.web/content/scrollbar/wisej.web.scrolleventargs) | A [ScrollEventArgs](https://docs.wisej.com/api/wisej.web/content/scrollbar/wisej.web.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. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnScrollAnimationEnd(e) Fires the [ScrollAnimationEnd](#scrollanimationend) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.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. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnScrollStepChanged(e) Fires the [ScrollStepChanged](#scrollstepchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnSpacingChanged(e) Fires the [SpacingChanged](#spacingchanged) event. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------- | | **e** | [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) | A [EventArgs](https://docs.microsoft.com/dotnet/api/system.eventargs) that contains the event data. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebEvent(e) Processes the event from the client. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------------------ | ---------------- | | **e** | [WisejEventArgs](https://docs.wisej.com/api/wisej.core/general/wisejeventargs) | Event arguments. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebRender(config) Renders the client component. | Parameter | Type | Description | | ---------- | ------------------------------------------------------------- | ----------------------------- | | **config** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic configuration object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-9bf7fa01e02f4da0f9ef90d3b049ae43e664919e%2Fprotected.png?alt=media) OnWebUpdate(state) Updates the client component using the state information. | Parameter | Type | Description | | --------- | ------------------------------------------------------------- | --------------------- | | **state** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic state object. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollBy(offset, duration) Scrolls the content by the specified *offset* in pixels. | Parameter | Type | Description | | ------------ | ----------------------------------------------------------- | --------------------------------------------------- | | **offset** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | Number of pixels to scroll by. | | **duration** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The time in milliseconds the scroll to should take. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollControlIntoView(control) Scrolls the specified child *control* into view. | Parameter | Type | Description | | ----------- | --------------------------------------------------------------- | -------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The child control to scroll into view. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollControlIntoView(control, alignX) Scrolls the specified child *control* into view. using the specified *alignX* preference. | Parameter | Type | Description | | ----------- | ------------------------------------------------------------------------------------------------------ | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The child control to scroll into view. | | **alignX** | [HorizontalAlignment](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.horizontalalignment) | Indicates the [HorizontalAlignment](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.horizontalalignment) preference. The final location of the control depends on the scrollable range and the available space. Note that [Center](https://docs.wisej.com/api/enumerations/wisej.web.horizontalalignment#fields) will not scroll the control to the center, but will instead scroll it into the closest visible location with the minimum movement. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollControlIntoView(control, alignY) Scrolls the specified child *control* into view. using the specified *alignY* preference. | Parameter | Type | Description | | ----------- | -------------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/wisej.web/general/control) | The child control to scroll into view. | | **alignY** | [VerticalAlignment](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.verticalalignment) | Indicates the [VerticalAlignment](https://docs.wisej.com/api/wisej.web/enumerations/wisej.web.verticalalignment) preference. The final location of the control depends on the scrollable range and the available space. Note that [Middle](https://docs.wisej.com/api/enumerations/wisej.web.verticalalignment#fields) will not scroll the control to the middle, but will instead scroll it into the closest visible location with the minimum movement. | ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollTo(position, duration) Scrolls the content to the specified *position* in pixels. | Parameter | Type | Description | | ------------ | ----------------------------------------------------------- | --------------------------------------------------- | | **position** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The position in pixels to scroll to. | | **duration** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | The time in milliseconds the scroll to should take. | ## Events ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) OrientationChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of [Orientation](#orientation) changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) Scroll [ScrollEventHandler](https://docs.wisej.com/api/wisej.web/content/scrollbar/wisej.web.scrolleventhandler) Fired when the [SlideBar](https://docs.wisej.com/api/wisej.web/containers/wisej.web.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. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollAnimationEnd [EventHandler](https://docs.microsoft.com/dotnet/api/system.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. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) ScrollStepChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of [ScrollStep](#scrollstep) changes. ### ![](https://1075938901-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F2HvlWXJQMV7DxhGzw7Y1%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media) SpacingChanged [EventHandler](https://docs.microsoft.com/dotnet/api/system.eventhandler) Fired when the value of [Spacing](#spacing) changes. ## Implements | Name | Description | | ---------------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------- | | [IUserData](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | | [IBindableComponent](https://docs.wisej.com/api/wisej.web/data-binding/wisej.web.ibindablecomponent) | Bindable components implement this interface. | | [IDropTarget](https://docs.wisej.com/api/wisej.web/interfaces/wisej.web.idroptarget) | Controls that support drag & drop operations implement this interface. | | [IWisejComponent](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejControl](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejcontrol) | All wisej controls derived from the [Control](https://docs.wisej.com/api/wisej.web/general/control) class must implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |