SlideBar
Wisej.Web.SlideBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.5.0.0)
Displays child controls vertically or horizontally in a scrollable container.
Constructors
SlideBar()
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Initializes a new instance of the SlideBar class.
Properties
BorderStyle
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
BorderStyle: Returns or sets the type of border that is drawn around the SlideBar control.
ButtonsBackColor
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Color: Returns or sets the background Color of the scroll buttons.
The default background color is set in the theme color as "slidebarButtons".
HorizontalScroll
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
HScrollProperties: Returns the properties associated with the horizontal scroll position.
LayoutEngine
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
LayoutEngine: Returns the control's layout engine.
Orientation
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Orientation: Returns or sets the Orientation of the SlideBar control.
ScrollStep
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Int32: Returns or sets the number of pixels to scroll when the scroll buttons are pressed.
Throws:
ArgumentOutOfRangeException The value is less than 1 or greater than 32000.
Spacing
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Int32: Returns or sets the spacing between the child controls.
Throws:
ArgumentOutOfRangeException The value is less than 0 or greater than 32000.
VerticalScroll
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
VScrollProperties: Returns the properties associated with the vertical scroll position.
Methods
ScrollBy(offset, duration)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Scrolls the content by the specified offset in pixels.
Parameter | Type | Description |
---|---|---|
offset | Number of pixels to scroll by. | |
duration | The time in milliseconds the scroll to should take. |
ScrollControlIntoView(control)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Scrolls the specified child control into view.
Parameter | Type | Description |
---|---|---|
control | The child control to scroll into view. |
ScrollControlIntoView(control, alignX)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Scrolls the specified child control into view. using the specified alignX preference.
Parameter | Type | Description |
---|---|---|
control | The child control to scroll into view. | |
alignX | 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)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Scrolls the specified child control into view. using the specified alignY preference.
Parameter | Type | Description |
---|---|---|
control | The child control to scroll into view. | |
alignY | 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)
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
Scrolls the content to the specified position in pixels.
Parameter | Type | Description |
---|---|---|
position | The position in pixels to scroll to. | |
duration | The time in milliseconds the scroll to should take. |
Events
OrientationChanged
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
EventHandler Fired when the value of Orientation changes.
Scroll
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
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
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
EventHandler Fired when the value of ScrollStep changes.
SpacingChanged
![](https://docs.wisej.com/~gitbook/image?url=https%3A%2F%2F314832588-files.gitbook.io%2F%7E%2Ffiles%2Fv0%2Fb%2Fgitbook-x-prod.appspot.com%2Fo%2Fspaces%252F-MTHCfAYyBPycFG90wsw-4198400543%252Fuploads%252Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%252Finstance.png%3Falt%3Dmedia%26token%3D060b281d-9363-48a1-a0f9-788ad1831e96&width=300&dpr=4&quality=100&sign=2218e05e&sv=1)
EventHandler Fired when the value of Spacing changes.
Implements
Name | Description |
---|---|
Bindable components implement this interface. | |
All wisej components implement this interface. | |
All wisej controls derived from the Control class must implement this interface. | |
Allows an object to serialize itself. |
Last updated