ScrollableControl

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ScrollableControl

Defines a base class for controls that support auto-scrolling behavior.

C#

public class ScrollableControl : Control

VB.NET

Public Class ScrollableControl
    Inherits Control

Constructors

ScrollableControl()

Initializes a new instance of the ScrollableControl class.

Properties

AutoScroll

Boolean: Returns or sets whether the container enables the user to scroll to any controls placed outside of its visible boundaries. (Default: False)

AutoScrollMargin

Size: Returns or sets the size of the auto-scroll margin. (Default: {Width=0, Height=0})

Throws:

• ArgumentOutOfRangeException The Height or Width value assigned is less than 0.

AutoScrollMinSize

Size: Returns or sets the minimum size of the auto-scroll. (Default: {Width=0, Height=0})

ClientArea

Rectangle: Returns the client rectangle to use in the designer.

DisplayRectangle

Rectangle: Returns the rectangle that represents the virtual display area of the control.

HorizontalScroll

HScrollProperties: Returns the properties associated with the horizontal scroll bar.

HScroll

Boolean: Returns whether the horizontal scroll bar is visible.

OverlappedScrollbars

Boolean: Returns whether the scrollbars are being created overlapped with the content in the browser at runtime.

ScrollBars

ScrollBars: Returns or sets the type of scroll bars to display for the ScrollableControl control. (Default: Both)

ScrollBarSize

Size: Returns the size of the native scrollbar in design mode and the themed scrollbar at runtime.

Selectable

Boolean: (Default: True)

VerticalScroll

VScrollProperties: Returns the properties associated with the vertical scroll bar.

VScroll

Boolean: Returns whether the vertical scroll bar is visible.

Methods

OnControlCreated(e)

Fires the ControlCreated event.

Parameter	Type	Description
e	EventArgs	A EventArgs that contains the event data.

OnRightToLeftChanged(e)

Fires the RightToLeftChanged event.

Parameter	Type	Description
e	EventArgs	An 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.

OnVisibleChanged(e)

Fires the VisibleChanged 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.

PointToClient(point)

Computes the location of the specified screen point into client coordinates.

Parameter	Type	Description
point	Point	The screen coordinate Point to convert.

Returns: Point. A Point that represents the converted Point, point , in client coordinates.

PointToScreen(point)

Computes the location of the specified client point into screen coordinates.

Parameter	Type	Description
point	Point	The client coordinate Point to convert.

Returns: Point. A Point that represents the converted Point, point , in screen coordinates.

ScrollControlIntoView(control)

Scrolls the specified child control into view.

Parameter	Type	Description
control	Control	The child control to scroll into view.

ScrollControlIntoView(control, alignX, alignY)

Scrolls the specified child control into view. using the specified alignX and alignY preferences.

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

Events

Scroll

ScrollEventHandler Fired when the user or code scrolls through the client area.

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.

Inherited By

Name	Description
TableLayoutPanel	Represents a panel that dynamically lays out its contents in a grid composed of rows and columns.
FileDialogUI	UI implementation for the FileDialog class.
FolderBrowserDialogUI	UI implementation for the FolderDialog class.
BindingNavigator	Represents the navigation and manipulation user interface (UI) for controls that are bound to a data source.
ContainerControl	Provides focus-management functionality for controls that can function as a container for other controls.
FlowLayoutPanel	Represents a panel that dynamically arranges its controls horizontally or vertically in automatic rows or columns.
Form	Represents a window or dialog box that makes up an application's user interface.
Page	Represents a web page that fills the browser and acts as the main container for the application. An application can have only one active main page at any given time.
Panel	Represents a collapsible panel with an optional header that contains a group of controls.
SplitContainer	Represents a control consisting of a movable bar that divides a container's display area into two resizable panels.
SplitterPanel	Creates a panel that is associated with a SplitContainer.
TabPage	Represents a single tab page in a TabControl.
UserControl	Provides an empty control that can be used to create other controls.
DataRepeater	Displays data in a customizable list format.
DataRepeaterItem	Used by the DataRepeater control to display data at run time.
Desktop	Represents a desktop container that can host floating windows.
AccordionPanel	Represents a panel in a Accordion control.
FlexLayoutPanel	Represents a panel that dynamically arranges its child controls.
UserPopup	Provides an popup container that can be attached to other controls.

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.