Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies the locations of the tabs in a tab control.

public enum TabAlignment : Enum

Public Enum TabAlignment As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the Selected or Deselected event of a TabControl control.

public delegate void TabControlEventHandler(Object sender, TabControlEventArgs e)

Public Delegate Sub TabControlEventHandler(ByVal sender As [Object], ByVal e As TabControlEventArgs)

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Defines values representing TabControl events.

public enum TabControlAction : Enum

Public Enum TabControlAction As [Enum]

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Represents the method that will handle the or event of a control.

Parameters

Fired By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Specifies how tabs in a are sized.

Fields

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the Selected and Deselected events of a TabControl control.

public class TabControlEventArgs : EventArgs

Public Class TabControlEventArgs
    Inherits EventArgs

Constructors

TabControlEventArgs(tabPage, tabPageIndex, action)

Initializes a new instance of the TabControlEventArgs class.

Properties

Action

TabControlAction: Returns a value indicating which event is occurring.

TabPage

TabPage: Returns the TabPage the event is occurring for.

TabPageIndex

Int32: Returns the zero-based index of the TabPage in the TabPages collection.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Provides data for the Selecting and Deselecting events of a TabControl control.

public class TabControlCancelEventArgs : CancelEventArgs

Public Class TabControlCancelEventArgs
    Inherits CancelEventArgs

Constructors

TabControlCancelEventArgs(tabPage, tabPageIndex, cancel, action)

Initializes a new instance of the TabControlCancelEventArgs class.

TabControlCancelEventArgs(tabPage, tabPageIndex, newTabPageIndex, cancel, action)

Initializes a new instance of the TabControlCancelEventArgs class.

Properties

Action

TabControlAction: Returns a value indicating which event is occurring.

NewTabPageIndex

Int32: Returns the zero-based index of the TabPage being selected when processing Deselecting otherwise it returns -1.

TabPage

TabPage: Returns the TabPage the event is occurring for.

TabPageIndex

Int32: Returns the zero-based index of the TabPage being selected when processing Selecting and Selected, or being deselected when processing Deselecting and Deselected.

Used By

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • ScrollableControl

    • Panel

      • TabPage

Represents a single tab page in a TabControl.

public class TabPage : Panel

Public Class TabPage
    Inherits Panel

Constructors

TabPage()

Initializes a new instance of the TabPage class.

TabPage(text)

Initializes a new instance of the TabPage class and specifies the text to display as the title the tab.

Properties

AllowHtml

Boolean: Returns or sets a value indicating that the control can display html in the Text property. (Default: False)

Newlines (CRLF) are converted to <BR/> when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.

CharacterCasing

CharacterCasing: Returns or sets the case of the text to display to the user. (Default: Normal)

Hidden

Boolean: Returns or sets whether the TabPage is visible in the parent TabControl. (Default: False)

ImageIndex

Int32: Returns or sets the index for the image in the ImageList of the associated TabControl. (Default: -1)

Throws:

• ArgumentOutOfRangeException The specified index is less than -1.

ImageKey

String: Returns or sets the key accessor for the image in the ImageList of the associated TabControl. (Default: "")

ShowCloseButton

Boolean: Returns or sets a value indicating that the tab can show the close button next to the name. (Default: False)

ShowInVisibilityMenu

Boolean: Returns or sets whether the tab page should be included in the visibility menu. (Default: True)

TabBackColor

Color: Returns or sets the background color of the TabPage tab button. (Default: Color [Empty])

TabControl

TabControl: Returns the parent TabControl.

TabForeColor

Color: Returns or sets the text color of the TabPage tab button. (Default: Color [Empty])

Text

String: Returns or sets the text to display on the tab. (Default: "")

ToolTipText

String: Returns or sets the ToolTip text for this tab. (Default: "")

UseMnemonic

Boolean: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True)

Visible

Boolean: Returns or sets whether the control and all its child controls are displayed. (Default: False)

Methods

CreateControlsInstance()

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

GetTabPageOfComponent(control)

Retrieves the tab page that contains the specified Control.

Returns: TabPage. The TabPage that contains the specified Control, or null if it cannot be found.

GetTabRect()

Returns the bounding rectangle for a specified tab in this tab control.

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

OnTextChanged(e)

Fires the TextChanged event.

OnWebEvent(e)

Processes the event from the client.

OnWebRender(config)

Renders the client component.

OnWebUpdate(state)

Updates the client component using the state information.

RenderPanelProperties(config)

Select()

Selects the current TabPage.

SetBoundsCore(x, y, width, height, specified)

This member overrides SetBoundsCore.

Update()

Overridden to update the parent TabControl when in design mode.

Events

TextChanged

EventHandler Fired when the value of the Text property changes.

Implements

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

• Control

  • TabControl

Manages a related set of TabPage pages.

public class TabControl : Control

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.

TabControl(tabPages, onSelectedIndexChanged)

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

TabControl(location, size, onSelectedIndexChanged)

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

TabControl(location, size, tabPages, onSelectedIndexChanged)

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

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.

Throws:

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

Throws:

• ArgumentNullExceptiontabPage is null.

DeselectTab(tabPageName)

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

Throws:

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

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.

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.

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.

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.

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.

Returns: String. The ToolTip text.

IsInputKey(keyData)

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

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

OnControlAdded(e)

Fires the ControlAdded event.

OnControlCreated(e)

Fires the ControlCreated event.

OnDeselected(e)

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

OnDeselecting(e)

Fires the Deselecting event.

OnEnter(e)

Fires the Enter event of the currently active TabPage.

OnLeave(e)

Fires the Leave event of the currently active TabPage.

OnScrollStepChanged(e)

Fires the ScrollStepChanged event.

OnSelected(e)

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

OnSelectedIndexChanged(e)

Fires the SelectedIndexChanged event.

OnSelecting(e)

Fires the Selecting event.

OnSizeChanged(e)

Fires the SizeChanged event.

OnTabClosed(e)

Fires the TabClosed event.

OnTabClosing(e)

Fires the TabClosing event.

OnTabMoved(e)

Fires the TabMoved event.

OnTabVisibilityChanged(e)

Fires the TabVisibilityChanged event.

OnWebEvent(e)

Processes the event from the client.

OnWebRender(config)

Renders the client component.

OnWebUpdate(state)

Updates the client component using the state information.

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.

Throws:

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

Throws:

• ArgumentNullExceptiontabPage is null.

SelectTab(tabPageName)

Makes the tab with the specified name the current tab.

Throws:

• ArgumentNullExceptiontabPageName 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

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.0.0.0)

Contains a collection of TabPage objects.

public class TabPageCollection : IList, ICollection, IEnumerable, IList<TabPage>, ICollection<TabPage>, IEnumerable<TabPage>

Public Class TabPageCollection
    Inherits IList
    Implements ICollection, IEnumerable, IList(Of TabPage), ICollection(Of TabPage), IEnumerable(Of TabPage)

Properties

Count

Int32: Returns the number of tab pages in the collection.

Item(index)

TabPage: Returns or sets a TabPage in the collection at the specified index.

Throws:

• ArgumentOutOfRangeExceptionindex is less than zero or greater than the highest available index.

• ArgumentNullExceptionvalue is null.

Item(name)

TabPage: Returns the TabPage with the specified key from the collection.

Methods

Add(tabPage)

Adds a TabPage to the collection.

Throws:

• ArgumentNullException The specified tabPage is null.

Add(text)

Creates a TabPage with the specified text, and adds it to the collection.

Add(key, text)

Creates a TabPage with the specified key and text and adds it to the collection.

Add(key, text, imageIndex)

Creates a TabPage with the specified key, text, and image, and adds it to the collection.

Add(key, text, imageKey)

Creates a TabPage with the specified key, text, and image, and adds it to the collection.

AddRange(pages)

Adds a set of TabPage pages to the collection.

Throws:

• ArgumentNullException The value of pages is null.

Clear()

Removes all the TabPage pages from the collection.

Clear(dispose)

Removes and disposes all TabPage pages from the collection.

Contains(tabPage)

Determines whether a specified TabPage is in the collection.

Returns: Boolean. true if the specified TabPage is in the collection; otherwise, false.

Throws:

• ArgumentNullException The value of tabPage is null.

ContainsKey(key)

Determines whether the collection contains a TabPage with the specified key.

Returns: Boolean. true to indicate a TabPage page with the specified key was found in the collection; otherwise, false.

CopyTo(array, index)

Copies the TabPage pages in the collection to the specified array, starting at the specified index.

Throws:

• ArgumentNullExceptionarray is null.

• ArgumentOutOfRangeExceptionarray is less than zero.

• ArgumentExceptionarray is multidimensional or the number of elements in the TabPageCollection is greater than the available space from index to the end of array .

IndexOf(tabPage)

Returns the index of the TabPage in the collection.

Returns: Int32. The zero-based index of the tab page; -1 if it cannot be found.

Throws:

• ArgumentNullException The value of tabPage is null.

IndexOfKey(key)

Returns the index of the first occurrence of the TabPage with the specified key.

Returns: Int32. The zero-based index of the first occurrence of a TabPage with the specified key, if found; otherwise, -1.

Insert(index, tabPage)

Inserts an existing TabPage into the collection at the specified index.

Insert(index, text)

Creates a new TabPage with the specified text and inserts it into the collection at the specified index.

Insert(index, key, text)

Creates a new TabPage with the specified key and text, and inserts it into the collection at the specified index.

Insert(index, key, text, imageIndex)

Creates a new TabPage with the specified key, text, and image, and inserts it into the collection at the specified index.

Insert(index, key, text, imageKey)

Creates a TabPage with the specified key, text, and image, and inserts it into the collection at the specified index.

Remove(tabPage)

Removes the TabPage from the collection.

Throws:

• ArgumentNullException The tabPage parameter is null.

RemoveAt(index)

Removes the TabPage at the specified index from the collection.

RemoveByKey(key)

Removes the TabPage with the specified key from the collection.