TabControl
Wisej.Web.TabControl
Last updated
Was this helpful?
Wisej.Web.TabControl
Last updated
Was this helpful?
Namespace: Wisej.Web
Assembly: Wisej.Framework (4.0.0.0)
Manages a related set of pages.
Initializes a new instance of the class.
Initializes a new instance of the class with the specified initial settings.
onSelectedIndexChanged
Initializes a new instance of the class with the specified initial settings.
tabPages
onSelectedIndexChanged
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
onSelectedIndexChanged
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
tabPages
onSelectedIndexChanged
The default value is Orientation.Horizontal.
Tab rows are not currently supported in Wisej.
Throws:
Throws:
The default value is TabSizeMode.Normal.
Makes the tab following the tab with the specified index the current tab.
index
Throws:
tabPage
Throws:
Makes the tab following the tab with the specified name the current tab.
tabPageName
Throws:
Activates the first eligible child control in the tab page.Since 3.5.4
index
Throws:
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
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.
index
The zero-based index of the tab page for which to retrieve the bounding rectangle of the tab button.
item
Determines whether the specified key is a regular input key or a special key that requires preprocessing.
keyData
e
e
e
e
e
e
e
e
e
e
e
e
e
e
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:
tabPage
Throws:
Makes the tab with the specified name the current tab.
tabPageName
Throws:
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.
Initializes a new instance of the class with the specified initial settings.
An Action delegate to handle the event.
Initializes a new instance of the class with the specified initial settings.
An array of objects to be added to the .
An Action delegate to handle the event.
: Returns or sets the area of the control (for example, along the top) where the tabs are aligned.
: Returns or sets whether the user can change the position of a tab button by dragging it. (Default: False
)
: Returns or sets the option to automatically activate the first focusable control of the when the is changed.Since 3.5.4 (Default: False
)
: Indicates the border style for the control. (Default: Solid
)
: Returns or sets the mode of the control to determine whether to display the icon, the text or both. (Default: Both
)
: Returns the display area of the control's tab pages.
: Returns or sets the images to display on the control's tabs. (Default: null
)
: Returns or sets the fixed size of the tab buttons. The default value is to use the itemSize set in the current theme or auto sizing.
When set to (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 is or ) is applied when the value is or . The height (or width when is or ) is applied always.
: Returns or sets a value indicating the horizontal or vertical orientation of the tabs.
: Returns the number of rows that are currently being displayed in the control's tab strip. (Default: 1
)
: Returns or sets the number of pixels to scroll when the scroll buttons are pressed. (Default: 15
)
The value is less than 1 or greater than 500.
: Returns or sets the index of the currently selected tab page. (Default: -1
)
The value is less than -1.
: Returns or sets the currently selected tab page. (Default: null
)
: Returns or sets whether a tab's ToolTip is shown when the mouse passes over the tab. (Default: False
)
: Returns or sets whether the tab visibility menu button is visible. (Default: False
)
: Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in .
: Gets the number of tabs in the tab strip. (Default: 0
)
: Returns the collection of tab pages in this tab control.
Default value is an empty
This member overrides .
Returns: . A new instance of assigned to the control.
The index in the collection of the tab to deselect.
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the tab following the specified the current tab.
The to deselect.
tabPage is null.
The of the tab to deselect.
tabPageName is null; or tabPageName does not match the property of any in the collection.
Invoked when the is changed and the property is true.
Returns the control at the specified location.
The index of the to get.
Returns: . The at the specified location.
index is less than 0 or greater than the number of controls in the collection minus 1.
Returns an array of controls that belong to the control.
Returns: . An array of controls that belong to the .
Returns the bounding rectangle for the tab button of the at the specified index in this control.
Returns: . A 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 will fire the event to inform the application that the bounding rectangles have been updated. In alternative, you can use the and overloads to query the client and receive the new bounding rectangle for the request tab page. Bounding rectangles are always empty until the has been rendered on the client.Throws:
The index is less than zero; or the index is greater than or equal to .
Retrieves the bounding rectangle for the tab button of the at the specified index in this control.
Bounding rectangles are always empty until the has been rendered on the client.Throws:
The index is less than zero; or the index is greater than or equal to .
The callback method is null.
Retrieves the bounding rectangle for the tab button of the at the specified index in this control.
Returns: .
Bounding rectangles are always empty until the has been rendered on the client.Throws:
The index is less than zero; or the index is greater than or equal to .
Returns the ToolTip for the specified .
The that owns the desired ToolTip.
Returns: . The ToolTip text.
One of the values.
Returns: . true if the specified key is a regular input key; otherwise, false.
Fires the event.
Fires the event.
A that contains the event data.
Fires the event and the event of the currently active .
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event of the currently active .
A that contains the event data.
Fires the event of the currently active .
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event and the event of the currently active .
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A that contains the event data.
Fires the event.
A object that contains the event data.
Fires the event.
A that contains the event data.
The index in the collection of the tab to select.
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the specified the current tab.
The to select.
tabPage is null.
The of the tab to select.
tabPageName is null; or tabPageName does not match the property of any in the collection.
Fired when a tab is deselected.
Occurs before a tab is deselected, enabling a handler to cancel the tab change.
Fired when the value of changes.
Fired when a tab is selected.
Fired when the property has changed.
Occurs before a tab is selected, enabling a handler to cancel the tab change.
Occurs after a tab is closed by the user and has been removed from the tab control.
Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing.
Fired when the user drags a into a new position and the property is set to true.
Occurs after a tab is shown or hidden by the user through the or programmatically through the property.
All wisej controls derived from the class must implement this interface.