TabControl

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • TabControl

Manages a related set of TabPage pages.

C#

public class TabControl : Control

VB.NET

Public Class TabControl
    Inherits Control

Constructors

TabControl()

Initializes a new instance of the TabControl class.

TabControl(onSelectedIndexChanged)

Initializes a new instance of the TabControl class with the specified initial settings.

Name	Type	Description
onSelectedIndexChanged	Action<Object, EventArgs>	An Action delegate to handle the SelectedIndexChanged event.

TabControl(tabPages, onSelectedIndexChanged)

Initializes a new instance of the TabControl class with the specified initial settings.

Name	Type	Description
tabPages	TabPage[]	An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged	Action<Object, EventArgs>	An Action delegate to handle the SelectedIndexChanged event.

TabControl(location, size, onSelectedIndexChanged)

Initializes a new instance of the TabControl class with the specified initial settings.

Name	Type	Description
location	Point	The location of the TabControl on its parent control.
size	Size	The size of the TabControl.
onSelectedIndexChanged	Action<Object, EventArgs>	An Action delegate to handle the SelectedIndexChanged event.

TabControl(location, size, tabPages, onSelectedIndexChanged)

Initializes a new instance of the TabControl class with the specified initial settings.

Name	Type	Description
location	Point	The location of the TabControl on its parent control.
size	Size	The size of the TabControl.
tabPages	TabPage[]	An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged	Action<Object, EventArgs>	An Action delegate to handle the SelectedIndexChanged event.

Properties

Alignment

TabAlignment: Returns or sets the area of the control (for example, along the top) where the tabs are aligned.

AllowUserToMoveTabs

Boolean: Returns or sets whether the user can change the position of a tab button by dragging it. (Default: False)

AutoActivateFirstChild

Boolean: Returns or sets the option to automatically activate the first focusable control of the TabPage when the SelectedTab is changed. Since 3.5.4 (Default: False)

BorderStyle

BorderStyle: Indicates the border style for the control. (Default: Solid)

Display

Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both. (Default: Both)

DisplayRectangle

Rectangle: Returns the display area of the control's tab pages.

ImageList

ImageList: Returns or sets the images to display on the control's tabs. (Default: null)

ItemSize

Size: Returns or sets the fixed size of the tab buttons. The default value is Empty to use the itemSize set in the current theme or auto sizing.

When set to Empty (default) it uses the itemSize set in the theme. You can also set only the width or the height and leave the other value set to 0 to use the value in the current theme or auto sizing.

The width (or height when Alignment is Left or Right) is applied when the value SizeMode is Fixed or Center.

The height (or width when Alignment is Top or Bottom) is applied always.

Orientation

Orientation: Returns or sets a value indicating the horizontal or vertical orientation of the TabControl tabs.

The default value is Orientation.Horizontal.

RowCount

Int32: Returns the number of rows that are currently being displayed in the control's tab strip. (Default: 1)

Tab rows are not currently supported in Wisej.

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

SelectedIndex

Int32: Returns or sets the index of the currently selected tab page. (Default: -1)

Throws:

• ArgumentOutOfRangeException The value is less than -1.

SelectedTab

TabPage: Returns or sets the currently selected tab page. (Default: null)

ShowToolTips

Boolean: Returns or sets whether a tab's ToolTip is shown when the mouse passes over the tab. (Default: False)

ShowVisibilityMenu

Boolean: Returns or sets whether the tab visibility menu button is visible. (Default: False)

SizeMode

TabSizeMode: Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in ItemSize.

The default value is TabSizeMode.Normal.

TabCount

Int32: Gets the number of tabs in the tab strip. (Default: 0)

TabPages

TabPageCollection: Returns the collection of tab pages in this tab control.

Default value is an empty TabPageCollection

Methods

CreateControlsInstance()

This member overrides CreateControlsInstance.

Returns: ControlCollection. A new instance of ControlCollection assigned to the control.

DeselectTab(index)

Makes the tab following the tab with the specified index the current tab.

Parameter	Type	Description
index	Int32	The index in the TabPages collection of the tab to deselect.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.

DeselectTab(tabPage)

Makes the tab following the specified TabPage the current tab.

Parameter	Type	Description
tabPage	TabPage	The TabPage to deselect.

Throws:

• ArgumentNullException tabPage is null.

DeselectTab(tabPageName)

Makes the tab following the tab with the specified name the current tab.

Parameter	Type	Description
tabPageName	String	The Name of the tab to deselect.

Throws:

• ArgumentNullException tabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.

FocusFirstChild()

Activates the first eligible child control in the tab page. Since 3.5.4

Invoked when the SelectedTab is changed and the property AutoActivateFirstChild is true.

GetControl(index)

Returns the TabPage control at the specified location.

Parameter	Type	Description
index	Int32	The index of the TabPage to get.

Returns: Control. The TabPage at the specified location.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.

GetItems()

Returns an array of TabPage controls that belong to the TabControl control.

Returns: Object[]. An array of TabPage controls that belong to the TabControl.

GetTabRect(index)

Returns the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.

Parameter	Type	Description
index	Int32	The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.

Returns: Rectangle. A Rectangle that represents the bounds of the specified tab.

Bounding rectangles for the tab buttons are received from the client and are updated asynchronously. If the application adds a tab page, or changes any property that causes the tab button to be resized (orientation, sizing, text, alignment, etc.) it cannot immediately after retrieve the new bounds.

When the tab rectangles are updated, the TabControl will fire the StyleChanged event to inform the application that the bounding rectangles have been updated.

In alternative, you can use the GetTabRect and GetTabRectAsync overloads to query the client and receive the new bounding rectangle for the request tab page.

Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:

• ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to TabCount.

GetTabRect(index, callback)

Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.

Parameter	Type	Description
index	Int32	The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
callback	Action<Rectangle>	Callback method that will receive the bounding rectangle for the request tab button.

Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:

• ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to Count.
• ArgumentNullException The callback method is null.

GetTabRectAsync(index)

Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.

Parameter	Type	Description
index	Int32	The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.

Returns: Task<Rectangle>.

Bounding rectangles are always empty until the TabControl has been rendered on the client. Throws:

• ArgumentOutOfRangeException The index is less than zero; or the index is greater than or equal to Count.

GetToolTipText(item)

Returns the ToolTip for the specified TabPage.

Parameter	Type	Description
item	Object	The TabPage that owns the desired ToolTip.

Returns: String. The ToolTip text.

IsInputKey(keyData)

Determines whether the specified key is a regular input key or a special key that requires preprocessing.

Parameter	Type	Description
keyData	Keys	One of the Keys values.

Returns: Boolean. true if the specified key is a regular input key; otherwise, false.

OnControlAdded(e)

Fires the ControlAdded event.

Parameter	Type	Description
e	ControlEventArgs

OnControlCreated(e)

Fires the ControlCreated event.

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

OnDeselected(e)

Fires the Deselected event and the Leave event of the currently active TabPage.

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

OnDeselecting(e)

Fires the Deselecting event.

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

OnEnter(e)

Fires the Enter event of the currently active TabPage.

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

OnLeave(e)

Fires the Leave event of the currently active TabPage.

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

OnScrollStepChanged(e)

Fires the ScrollStepChanged event.

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

OnSelected(e)

Fires the Selected event and the Enter event of the currently active TabPage.

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

OnSelectedIndexChanged(e)

Fires the SelectedIndexChanged event.

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

OnSelecting(e)

Fires the Selecting event.

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

OnSizeChanged(e)

Fires the SizeChanged event.

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

OnTabClosed(e)

Fires the TabClosed event.

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

OnTabClosing(e)

Fires the TabClosing event.

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

OnTabMoved(e)

Fires the TabMoved event.

Parameter	Type	Description
e	TabControlEventArgs	A TabControlEventArgs object that contains the event data.

OnTabVisibilityChanged(e)

Fires the TabVisibilityChanged event.

Parameter	Type	Description
e	TabControlEventArgs	A TabControlEventArgs 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.

RemoveAll()

Removes all the tab pages and additional controls from this tab control.

SelectTab(index)

Makes the tab with the specified index the current tab.

Parameter	Type	Description
index	Int32	The index in the TabPages collection of the tab to select.

Throws:

• ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.

SelectTab(tabPage)

Makes the specified TabPage the current tab.

Parameter	Type	Description
tabPage	TabPage	The TabPage to select.

Throws:

• ArgumentNullException tabPage is null.

SelectTab(tabPageName)

Makes the tab with the specified name the current tab.

Parameter	Type	Description
tabPageName	String	The Name of the tab to select.

Throws:

• ArgumentNullException tabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.

Events

Deselected

TabControlEventHandler Fired when a tab is deselected.

Deselecting

TabControlCancelEventHandler Occurs before a tab is deselected, enabling a handler to cancel the tab change.

ScrollStepChanged

EventHandler Fired when the value of ScrollStep changes.

Selected

TabControlEventHandler Fired when a tab is selected.

SelectedIndexChanged

EventHandler Fired when the SelectedIndex property has changed.

Selecting

TabControlCancelEventHandler Occurs before a tab is selected, enabling a handler to cancel the tab change.

TabClosed

TabControlEventHandler Occurs after a tab is closed by the user and has been removed from the tab control.

TabClosing

TabControlCancelEventHandler Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing.

TabMoved

TabControlEventHandler Fired when the user drags a TabPage into a new position and the AllowUserToMoveTabs property is set to true.

TabVisibilityChanged

TabControlEventHandler Occurs after a tab is shown or hidden by the user through the ShowVisibilityMenu or programmatically through the Hidden property.

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.