TabControl
Wisej.Web.TabControl
Last updated
Was this helpful?
v4.0
Wisej.Web.TabControl
Last updated
Was this helpful?
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Manages a related set of TabPage pages.
public class TabControl : ControlInitializes a new instance of the TabControl class.
Initializes a new instance of the TabControl class with the specified initial settings.
onSelectedIndexChanged
Initializes a new instance of the TabControl class with the specified initial settings.
tabPages
onSelectedIndexChanged
Initializes a new instance of the TabControl class with the specified initial settings.
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
onSelectedIndexChanged
Initializes a new instance of the TabControl class with the specified initial settings.
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
tabPages
onSelectedIndexChanged
TabAlignment: Returns or sets the area of the control (for example, along the top) where the tabs are aligned.
Boolean: Returns or sets whether the user can change the position of a tab button by dragging it. (Default: False)
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: Indicates the border style for the control. (Default: Solid)
Display: Returns or sets the Display mode of the control to determine whether to display the icon, the text or both. (Default: Both)
Rectangle: Returns the display area of the control's tab pages.
ImageList: Returns or sets the images to display on the control's tabs. (Default: null)
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: Returns or sets a value indicating the horizontal or vertical orientation of the TabControl tabs.
The default value is Orientation.Horizontal.
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.
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.
Int32: Returns or sets the index of the currently selected tab page. (Default: -1)
Throws:
ArgumentOutOfRangeException The value is less than -1.
TabPage: Returns or sets the currently selected tab page. (Default: null)
Boolean: Returns or sets whether a tab's ToolTip is shown when the mouse passes over the tab. (Default: False)
Boolean: Returns or sets whether the tab visibility menu button is visible. (Default: False)
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.
Int32: Gets the number of tabs in the tab strip. (Default: 0)
TabPageCollection: Returns the collection of tab pages in this tab control.
Default value is an empty TabPageCollection
This member overrides CreateControlsInstance.
Returns: ControlCollection. A new instance of ControlCollection assigned to the control.
Makes the tab following the tab with the specified index the current tab.
index
Throws:
ArgumentOutOfRangeExceptionindex is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Makes the tab following the specified TabPage the current tab.
tabPage
Throws:
ArgumentNullExceptiontabPage is null.
Makes the tab following the tab with the specified name the current tab.
tabPageName
Throws:
ArgumentNullExceptiontabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.
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.
Returns the TabPage control at the specified location.
index
Returns: Control. The TabPage at the specified location.
Throws:
ArgumentOutOfRangeExceptionindex is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Returns an array of TabPage controls that belong to the TabControl control.
Returns: Object[]. An array of TabPage controls that belong to the TabControl.
Returns the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
index
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.
Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
callback
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.
Retrieves the bounding rectangle for the tab button of the TabPage at the specified index in this TabControl control.
index
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.
Returns the ToolTip for the specified TabPage.
item
Returns: String. The ToolTip text.
Determines whether the specified key is a regular input key or a special key that requires preprocessing.
keyData
Returns: Boolean. true if the specified key is a regular input key; otherwise, false.
Fires the ControlAdded event.
e
Fires the ControlCreated event.
e
Fires the Deselected event and the Leave event of the currently active TabPage.
e
Fires the Deselecting event.
e
Fires the Enter event of the currently active TabPage.
e
Fires the Leave event of the currently active TabPage.
e
Fires the ScrollStepChanged event.
e
Fires the Selected event and the Enter event of the currently active TabPage.
e
Fires the SelectedIndexChanged event.
e
Fires the Selecting event.
e
Fires the SizeChanged event.
e
Fires the TabClosed event.
e
Fires the TabClosing event.
e
Fires the TabMoved event.
e
Fires the TabVisibilityChanged event.
e
Processes the event from the client.
e
Event arguments.
Renders the client component.
config
Dynamic configuration object.
Updates the client component using the state information.
state
Dynamic state object.
Removes all the tab pages and additional controls from this tab control.
Makes the tab with the specified index the current tab.
index
Throws:
ArgumentOutOfRangeExceptionindex is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
Makes the specified TabPage the current tab.
tabPage
Throws:
ArgumentNullExceptiontabPage is null.
Makes the tab with the specified name the current tab.
tabPageName
Throws:
ArgumentNullExceptiontabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.
TabControlEventHandler Fired when a tab is deselected.
TabControlCancelEventHandler Occurs before a tab is deselected, enabling a handler to cancel the tab change.
EventHandler Fired when the value of ScrollStep changes.
TabControlEventHandler Fired when a tab is selected.
EventHandler Fired when the SelectedIndex property has changed.
TabControlCancelEventHandler Occurs before a tab is selected, enabling a handler to cancel the tab change.
TabControlEventHandler Occurs after a tab is closed by the user and has been removed from the tab control.
TabControlCancelEventHandler Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing.
TabControlEventHandler Fired when the user drags a TabPage into a new position and the AllowUserToMoveTabs property is set to true.
TabControlEventHandler Occurs after a tab is shown or hidden by the user through the ShowVisibilityMenu or programmatically through the Hidden property.
Provides access to the UserData and Tag properties associated to the component implementing this interface.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
Allows an object to serialize itself.
An Action delegate to handle the event.
An array of objects to be added to the .
An Action delegate to handle the event.
An Action delegate to handle the event.
An array of objects to be added to the .
An Action delegate to handle the event.
The index in the collection of the tab to deselect.
The to deselect.
The of the tab to deselect.
The index of the to get.
The that owns the desired ToolTip.
One of the values.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A that contains the event data.
A object that contains the event data.
A that contains the event data.
The index in the collection of the tab to select.
The to select.
The of the tab to select.
All wisej controls derived from the class must implement this interface.
