TabPage

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Control
  • ScrollableControl
    • Panel
      • TabPage

Represents a single tab page in a TabControl.

C#

public class TabPage : Panel

VB.NET

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.

Name	Type	Description
text	String	The text for 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.

Parameter	Type	Description
control	Control	The Control to look for.

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.

GetThemeStateName()

Returns: String.

OnTextChanged(e)

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

RenderPanelProperties(config)

Parameter	Type	Description
config	Object

Select()

Selects the current TabPage.

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

This member overrides SetBoundsCore.

Parameter	Type	Description
x	Int32	The new Left property value of the control.
y	Int32	The new Top property value of the control.
width	Int32	The new Width property value of the control.
height	Int32	The new Height property value of the control.
specified	BoundsSpecified	A combination of BoundsSpecified values.

Update()

Overridden to update the parent TabControl when in design mode.

Events

TextChanged

EventHandler Fired when the value of the Text property changes.

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.
IImage	Provides access to common image properties across the controls that 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.