ScrollBar
Wisej.Web.ScrollBar
Namespace: Wisej.Web
Assembly: Wisej.Framework (2.5.0.0)
Implements the basic functionality of a scroll bar control.
C#
VB.NET
1
public class ScrollBar : Control
Copied!
1
Public Class ScrollBar
2
Inherits Control
Copied!

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.
Throws:

Maximum

Int32: Returns or sets the upper limit of values of the scrollable range.

Minimum

Int32: Returns or sets the lower limit of values of the scrollable range.

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.
Throws:

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.

Value

Int32: Returns or sets a numeric value that represents the current position of the scroll box on the scroll bar control.
Throws:

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

Properties

Name
Description
From
Returns or sets the description that will be reported to accessibility client applications. It is assigned to the "alt" attribute of the browser element.
Control
Returns or sets the name of the control for use by accessibility client applications. It is assigned to the "name" attribute of the browser element.
Control
Returns or sets the accessible role of the control that will be reported to accessibility client applications. It is assigned to the "role" attribute of the browser element.
Control
Anchor
Returns or sets the edges of the container to which a control is bound and determines how a control is resized with its parent.
Control
Anonymous
Returns or sets whether the control receives pointer events. Anonymous controls let pointer events bubble to their parents.
Control
Returns a flag indicating that the control is becoming the active control.
Control
Determines whether the control can execute a command.
Control
CanFocus
Returns whether the control can receive focus.
Control
Returns or sets whether the control causes validation to be performed on controls that require to be validated when this control receives focus.
Control
Returns a collection of client events and JavaScript listeners. You may attach multiple listeners to same event.
Control
Container
Component
Indicates whether the control, or one of its child controls, has the input focus.
Control
Controls
Returns the collection of controls contained within the control.
Control
CssClass
Returns or sets additional CSS class names to add to the widget.
Control
CssStyle
Returns or sets the custom CSS styles to add to the widget.
Control
Cursor
Returns or sets the cursor that is displayed when the mouse pointer is over the control.
Control
Returns the data bindings for the control.
Control
Returns the rectangle that represents the virtual display area of the control.
Control
Dock
Returns or sets which control borders are docked to its parent control and determines how a control is resized with its parent.
Control
Enabled
Returns or sets whether the control can respond to user interaction.
Control
Enables or disables the browser's context menu.
Control
Focusable
Returns or sets whether the control can gain the focus.
Control
Focused
Returns a value indicating whether the control has input focus.
Control
Handle
Returns the unique server-side id (handle) for this component.
Control
Returns whether the control specifies data bindings.
Control
Check if the control defines any responsive profile without forcing the creation of the collection.
Control
Checks if the UserData dynamic object was created and has any value.
Control
Height
Returns or sets the height of the control.
Control
Returns or sets an initialization script to execute when the widget is created (or reloaded) in the browser.
Control
Returns if the control has a server-side component id (handle) associated with it.
Control
Returns whether the control is mirrored.
Control
Returns the control's layout engine.
Control
Left
Returns or sets the distance, in pixels, between the left edge of the control and the left edge of its container's client area.
Control
Location
Returns or sets the coordinates of the upper-left corner of the control relative to the upper-left corner of its container.
Control
Margin
Returns or sets the space between controls.
Control
Returns or sets the maximum size for the control.
Control
Returns or sets the minimum size for the control.
Control
Movable
Returns or sets whether the control can be moved by dragging.
Control
Name
Gets or sets the name of the control.
Control
Parent
Returns or sets the parent container of the control.
Control
Returns the preferred size in which the control can fit.
Control
Returns or sets the edges of the control that can be dragged to resize the control.
Control
Returns or sets whether the control is blocked by the ajax loader.
Control
Size
Returns or sets the height and width of the control.
Control
States
Returns or sets additional theme states to the client widget.
Control
TabIndex
Returns or sets the tab order of the control within its container.
Control
Tag
Returns or sets the object that contains data about the control.
Control
Returns or sets the tooltip text to show for this control.
Control
Top
Returns or sets the distance, in pixels, between the top edge of the control and the top edge of its container's client area.
Control
UserData
Returns a dynamic object that can be used to store custom data in relation to this control.
Control
Returns or sets whether to use the wait cursor for the current control and all child controls.
Control
Returns a flag indicating that the validation has been canceled.
Control
Visible
Returns or sets whether the control and all its child controls are displayed.
Control
Width
Returns or sets the width of the control.
Control

Methods

Name
Description
From
Adds a new listener script to the event name to the client widget.
Control
Adds the CSS class name to the widget element. If the class already exists in the CssClass it's not added.
Control
Adds the specified theme state to the widget.
Control
Executes the specified delegate asynchronously.
Control
Brings the control to the front of the z-order.
Control
Runs the JavaScript function within the component's context in the browser.
Control
Runs the JavaScript function within the component's context in the browser and returns the value to the callback method.
Control
Asynchronously runs the JavaScript function within the component's context in the browser and returns an awaitable Task containing the value returned by the remote call.
Control
Centers the position of the control within the bounds of the parent.
Control
Centers the position of the control within the bounds of the parent either horizontally, vertically or both.
Control
Indicates whether the specified control is a child of this control.
Control
Creates and register this control and all its children.
Control
Dispose()
Component
Begins a drag-and-drop operation.
Control
Begins a drag-and-drop operation.
Control
Begins a drag-and-drop operation.
Control
Begins a drag-and-drop operation.
Control
Begins a drag-and-drop operation.
Control
Runs the javaScript code within the component's context in the browser.
Control
Runs the javaScript code within the component's context in the browser and returns the value to the callback method.
Control
Asynchronously runs the javaScript code within the component's context in the browser and returns an awaitable Task that contains the value returned by the remote call.
Control
Retrieves the form that the control is on.
Control
Retrieves the page that the control is on.
Control
Focus()
Sets input focus to the control.
Control
Retrieves the child control that is located at the specified coordinates, specifying whether to ignore child controls of a certain type.
Control
Retrieves the child control that is located at the specified coordinates.
Control
Returns the script associated to the listener identified by id .
Control
Returns the scripts for all the listeners attached to the event name .
Control
Returns the next IContainerControl up the control's chain of parents.
Control
Retrieves the next control forward or back in the tab order of child controls.
Control
Retrieves the value of the specified control style bit for the control.
Control
Checks whether the specified event name has any listener attached.
Control
Returns true if the property CssClass contains the specified class name .
Control
Checks whether the specified theme state is present in the States property.
Control
Hide()
Conceals the control from the user.
Control
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Control
Causes the control to update the client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Control
Executes the specified delegate.
Control
Executes the specified delegate, on the thread that owns the control's underlying window handle, with the specified list of arguments.
Control
Computes the location of the specified screen point into client coordinates.
Control
Computes the location of the specified client point into screen coordinates.
Control
Computes the size and location of the specified screen rectangle in client coordinates.
Control
Computes the size and location of the specified client rectangle in screen coordinates.
Control
Refresh()
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control, including the non-client areas such as the caption of forms or panels.
Control
Forces the control to update corresponding client widget. When in DesignMode it forces a full redraw of the designer surface for this control and optionally of its children, including the non-client areas such as the caption of forms or panels.
Control
Detaches and removes the listener identified by id .
Control
Removes all the listeners attached to the event name .
Control
Removes the specified css class name from the control's CssClass property.
Control
Removes the specified theme state from the widget.
Control
Causes a control bound to the BindingSource to reread all the items in the list and refresh their displayed values.
Control
Resumes layout logic.
Control
Resumes layout logic, optionally forcing an immediate layout of all pending layout requests.
Control
Scrolls the control into view in the container using the specified alignX and alignY preferences.
Control
Scrolls the child control into view.
Control
Select()
Activates a control.
Control
Activates the next control in the list according to the specified selection rules.
Control
Sends the control to the back of the z-order.
Control
Sets the bounds of the control to the specified location and size.
Control
Sets the specified bounds of the control to the specified location and size.
Control
Show()
Displays the control to the user.
Control
Suspends the layout logic for the control.
Control
Update()
Causes the control to update the corresponding client side widget. When in design mode, causes the rendered control to update its entire surface in the designer.
Control
Validates all selectable child controls in the container, including descendants. This is equivalent to calling ValidateChildren(ValidationConstraints.Selectable). See Selectable for details of exactly which child controls will be validated.
Control
Validates all the child controls in the container. Exactly which controls are validated and which controls are skipped is determined by flags .
Control

Events

Name
Description
From
Appear
Fired after the control has been fully rendered on the client.
Control
BindingContextChanged
Occurs when the value of the BindingContext property changes.
Control
CausesValidationChanged
Fired when the value of the CausesValidation property changes.
Control
Click
Fired when the control is clicked.
Control
ClientSizeChanged
Fired when the ClientSize property value changes.
Control
ContextMenuChanged
Fired when the value of the ContextMenu property changes.
Control
ControlCreated
Fired when a control is made visible the first time, fully created and sent to the client.
Control
CursorChanged
Fired when the value of the Cursor property changes.
Control
Disappear
Fired after the control is no longer visible on the client.
Control
Disposed
Fired when the component is disposed.
Control
DockChanged
Fired when the value of the Dock property changes.
Control
DoubleClick
Fired when the control is double-clicked.
Control
DragDrop
Fired when a drag-and-drop operation is completed.
Control
DragEnd
Fired when a drag-drop operation is terminated either by a drop or canceled.
Control
DragEnter
Fired when an object is dragged into the control's bounds.
Control
DragLeave
Fired when an object is dragged out of the control's bounds.
Control
DragOver
Fired when an object is dragged over the control's bounds.
Control
DragStart
Fired when a drag-drop operation is started by the user.
Control
EnabledChanged
Fired when the Enabled property value has changed.
Control
EndMove
Fired when a control is Movable and the user ends the move operation.
Control
EndResize
Fired when a control has ResizableEdges and the user ends the resize operation.
Control
Enter
Fired when the control gains the input focus.
Control
HelpRequested
Fired when the user requests help for a control by pressing F1.
Control
KeyDown
Fired when a key is pressed while the control has focus.
Control
KeyPress
Fired when a key is pressed while the control has focus.
Control
KeyUp
Fired when a key is released while the control has focus.
Control
Layout
Fired when a control should reposition its child controls.
Control
Leave
Fired when the control loses the input focus.
Control
LocationChanged
Fired when the Location property value has changed.
Control
LongTap
Fired when a pointer holds on the screen.
Control
MarginChanged
Fired when the control's margin changes.
Control
MouseCaptureChanged
Fired when the control loses mouse capture.
Control
MouseClick
Fired when the control is clicked by the mouse.
Control
MouseDoubleClick
Fired when the control is double clicked by the mouse.
Control
MouseDown
Fired when the mouse pointer is over the control and a mouse button is pressed.
Control
MouseEnter
Fired when the mouse pointer enters the control.
Control
MouseHover
Fired when the mouse pointer rests on the control.
Control
MouseLeave
Fired when the mouse pointer leaves the control.
Control
MouseMove
Fired when the mouse pointer is moved over the control.
Control
MouseUp
Fired when the mouse pointer is over the control and a mouse button is released.
Control
MouseWheel
Fired when the mouse wheel moves while the control has focus.
Control
PaddingChanged
Fired when the control's padding changes.
Control
Paint
Fired when a UserPaint control needs to redraw itself.
Control
ParentChanged
Fired when the Parent property value changes.
Control
Pinch
Fired when two finger moved towards or away from each other. It contains the scaling factor of the pinch.
Control
PreviewKeyDown
Fired before the KeyDown event when a key is pressed while focus is on this control.
Control
QueryContinueDrag
Occurs during a drag-and-drop operation and enables the drag source to determine whether the drag-and-drop operation should be canceled.
Control
Resize
Fired when the control is resized.
Control
ResponsiveProfileChanged
Fired when the active responsive profile is changed.
Control
RightToLeftChanged
Fired when the RightToLeft property value changes.
Control
Rotate
Fired when two finger moved around a single point. It contains the angle of the rotation.
Control
SizeChanged
Fired when the Size property value changes.
Control
StartMove
Fired when a control is Movable and the user begins the move operation.
Control
StartResize
Fired when a control has ResizableEdges and the user begins the resize operation.
Control
StyleChanged
Fired when the control style changed.
Control
Swipe
Fired when a pointer swipes over the screen.
Control
TabIndexChanged
Fired when the TabIndex property value has changed.
Control
TabStopChanged
Fired when the value of the TabStop property changes.
Control
Tap
Fired when a pointer taps on the screen.
Control
TouchCancel
Fired when a touch point has been disrupted in an implementation-specific manner (for example, too many touch points are created).
Control
TouchEnd
Fired when a touch point is removed from the touch surface.
Control
TouchMove
Fired when a touch point is moved along the touch surface.
Control
TouchStart
Fired when a touch point is placed on the touch surface.
Control
Track
Fired when a pointer grabs an item and moves the pointer on it.
Control
Validated
Fired when the control is finished validating.
Control
Validating
Fired when the control is validating.
Control
VisibleChanged
Fired when the Visible property value changes.
Control
WidgetEvent
Fired when the control receives a custom event from the client.
Control

Extension Methods

Name
Description
From
Sounds a tone through the computer's speaker.
Displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
Asynchronous displays a prompt in a dialog box, waits for the user to input text or click a button, and then returns a string containing the contents of the text box.
Displays a message in a dialog box, waits for the user to click a button, and then returns an integer indicating which button the user clicked.
Asynchronously displays a message in a dialog box, waits for the user to click a button, and then returns an integer indicating which button the user clicked.
Serializes the object to a JSON string.
JSON
Serializes the object to a JSON string.
JSON

Inherited By

Name
Description
Represents an horizontal scroll bar.
Represents a vertical scroll bar.
Last modified 3mo ago