Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Name | Description |
---|---|
Name | Description |
---|---|
Contains a collection of objects.
: Returns the number of tab pages in the collection.
: Returns or sets a in the collection at the specified index.
index is less than zero or greater than the highest available index.
value is null.
: Returns the with the specified key from the collection.
Adds a to the collection.
Parameter | Type | Description |
---|
The specified tabPage is null.
Creates a with the specified text, and adds it to the collection.
Parameter | Type | Description |
---|
Creates a with the specified key and text and adds it to the collection.
Parameter | Type | Description |
---|
Creates a with the specified key, text, and image, and adds it to the collection.
Parameter | Type | Description |
---|
Creates a with the specified key, text, and image, and adds it to the collection.
Parameter | Type | Description |
---|
Adds a set of pages to the collection.
Parameter | Type | Description |
---|
The value of pages is null.
Removes all the pages from the collection.
Removes and disposes all pages from the collection.
Parameter | Type | Description |
---|
Determines whether a specified is in the collection.
Parameter | Type | Description |
---|
Returns: . true if the specified is in the collection; otherwise, false.
The value of tabPage is null.
Determines whether the collection contains a with the specified key.
Parameter | Type | Description |
---|
Returns: . true to indicate a page with the specified key was found in the collection; otherwise, false.
Copies the pages in the collection to the specified array, starting at the specified index.
Parameter | Type | Description |
---|
array is null.
array is less than zero.
array is multidimensional or the number of elements in the is greater than the available space from index to the end of array .
Returns the index of the in the collection.
Parameter | Type | Description |
---|
Returns: . The zero-based index of the tab page; -1 if it cannot be found.
The value of tabPage is null.
Returns the index of the first occurrence of the with the specified key.
Parameter | Type | Description |
---|
Returns: . The zero-based index of the first occurrence of a with the specified key, if found; otherwise, -1.
Inserts an existing into the collection at the specified index.
Parameter | Type | Description |
---|
Creates a new with the specified text and inserts it into the collection at the specified index.
Parameter | Type | Description |
---|
Creates a new with the specified key and text, and inserts it into the collection at the specified index.
Parameter | Type | Description |
---|
Creates a new with the specified key, text, and image, and inserts it into the collection at the specified index.
Parameter | Type | Description |
---|
Creates a with the specified key, text, and image, and inserts it into the collection at the specified index.
Parameter | Type | Description |
---|
Removes the from the collection.
Parameter | Type | Description |
---|
The tabPage parameter is null.
Removes the at the specified index from the collection.
Parameter | Type | Description |
---|
Removes the with the specified key from the collection.
Parameter | Type | Description |
---|
Bottom
The tab buttons are located across the bottom of the control.
Left
The tab buttons are located along the left edge of the control.
Right
The tab buttons are located along the right edge of the control.
Top
The tab buttons are located across the top of the control.
Returns or sets the area of the control (for example, along the top) where the tabs are aligned.
Returns or sets the area of the control (for example, along the top) where the tabs are aligned.
tabPage |
text |
key |
text |
key |
text |
imageIndex |
key |
text |
imageKey |
pages |
dispose |
tabPage |
key |
array | The one-dimensional array that is the destination of the tab pages copied from the collection. The array must have zero-based indexing. |
index | The zero-based index in the array at which copying begins. |
tabPage |
key |
index |
tabPage |
index |
text |
index |
key |
text |
index |
key | The name of the tab page. |
text |
imageIndex |
index |
key | The name of the tab page. |
text |
imageKey |
tabPage |
index |
key |
Wisej.Web.TabControlCancelEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Provides data for the Selecting and Deselecting events of a TabControl control.
Initializes a new instance of the TabControlCancelEventArgs class.
Initializes a new instance of the TabControlCancelEventArgs class.
TabControlAction: Returns a value indicating which event is occurring.
Int32: Returns the zero-based index of the TabPage being selected when processing Deselecting otherwise it returns -1.
TabPage: Returns the TabPage the event is occurring for.
Int32: Returns the zero-based index of the TabPage being selected when processing Selecting and Selected, or being deselected when processing Deselecting and Deselected.
Wisej.Web.TabControlAction
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Defines values representing TabControl events.
The to add.
The text to display on the .
The name of the .
The text to display on the .
The name of the .
The text to display on the .
The index of the image to display on the .
The name of the .
The text to display on the .
The key of the image to display on the .
An array of type that contains the pages to add.
Indicates whether to dispose the pages removed from the collection.
The to locate in the collection.
The name of the page to search for.
The to locate in the collection.
The name of the to find in the collection.
The zero-based index location where the page is inserted.
The to insert in the collection.
The zero-based index location where the page is inserted.
The text to display in the page.
The zero-based index location where the is inserted.
The name of the .
The text to display on the .
The zero-based index location where the is inserted
The text to display on the .
The zero-based index of the image to display on the .
The zero-based index location where the is inserted.
The text to display on the .
The key of the image to display on the .
The to remove.
The zero-based index of the to remove.
The name of the page to remove.
Name | Type | Description |
---|---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Description |
---|---|
Name | Description |
---|---|
tabPage
The TabPage the event is occurring for.
tabPageIndex
The zero-based index of tabPage in the TabPages collection.
cancel
true to cancel the tab change by default; otherwise, false.
action
One of the TabControlAction values.
tabPage
The TabPage the event is occurring for.
tabPageIndex
The zero-based index of tabPage in the TabPages collection.
newTabPageIndex
The zero-based index of tabPage in the TabPages collection.
cancel
true to cancel the tab change by default; otherwise, false.
action
One of the TabControlAction values.
Represents the method that will handle the Selecting or Deselecting event of a TabControl control.
Closed
Represents the TabClosed event.
Closing
Represents the TabClosing event.
Deselected
Represents the Deselected event.
Deselecting
Represents the Deselecting event.
Selected
Represents the Selected event.
Selecting
Represents the Selecting event.
VisibilityChanged
Represents the TabVisibilityChanged event.
Returns a value indicating which event is occurring.
Returns a value indicating which event is occurring.
Wisej.Web.TabControlEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Represents the method that will handle the Selected or Deselected event of a TabControl control.
Wisej.Web.TabControlEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Provides data for the Selected and Deselected events of a TabControl control.
Initializes a new instance of the TabControlEventArgs class.
TabControlAction: Returns a value indicating which event is occurring.
TabPage: Returns the TabPage the event is occurring for.
Int32: Returns the zero-based index of the TabPage in the TabPages collection.
Wisej.Web.TabPage
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Newlines (CRLF) are converted to <BR/> when allowHtml is false, or when allowHtml is true and the text doesn't contain any html.
Throws:
Returns the bounding rectangle for a specified tab in this tab control.
Overridden to update the parent TabControl when in design mode.
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Name | Type | Description |
---|---|---|
Name | Description |
---|---|
Specifies how tabs in a are sized.
Name | Description |
---|
Name | Description |
---|
Represents a single tab page in a .
Initializes a new instance of the class.
Initializes a new instance of the class and specifies the text to display as the title the tab.
Name | Type | Description |
---|
: Returns or sets a value indicating that the control can display html in the Text property. (Default: False
)
: Returns or sets the case of the text to display to the user. (Default: Normal
)
: Returns or sets whether the is visible in the parent . (Default: False
)
: Returns or sets the index for the image in the of the associated . (Default: -1
)
The specified index is less than -1.
: Returns or sets the key accessor for the image in the of the associated . (Default: ""
)
: Returns or sets a value indicating that the tab can show the close button next to the name. (Default: False
)
: Returns or sets whether the tab page should be included in the visibility menu. (Default: True
)
: Returns or sets the background color of the tab button. (Default: Color [Empty]
)
: Returns the parent .
: Returns or sets the text color of the tab button. (Default: Color [Empty]
)
: Returns or sets the text to display on the tab. (Default: ""
)
: Returns or sets the ToolTip text for this tab. (Default: ""
)
: Returns or sets whether the first character that is preceded by an ampersand (&) is used as the mnemonic key of the control. (Default: True
)
: Returns or sets whether the control and all its child controls are displayed.
Retrieves the tab page that contains the specified .
Parameter | Type | Description |
---|
Returns: . The that contains the specified , or null if it cannot be found.
Returns: . A that represents the bounds of the specified tab.
Fired when the value of the property changes.
Name | Description |
---|
Represents the method that will handle the or event of a control.
Name | Type | Description |
---|
Name | Description |
---|
sender
The source of the event.
e
A TabControlEventArgs that contains the event data.
Occurs after a tab is closed by the user and has been removed from the tab control.
Occurs after a tab is shown or hidden by the user through the ShowVisibilityMenu or programmatically through the Hidden property.
Fired when a tab is selected.
Fired when a tab is deselected.
tabPage
The TabPage the event is occurring for.
tabPageIndex
The zero-based index of tabPage in the TabPages collection.
action
One of the TabControlAction values.
Represents the method that will handle the Selected or Deselected event of a TabControl control.
Center |
Fill |
Fixed | All tab buttons use the same width (or height when vertically aligned). |
Normal | The width (or height when vertically aligned) of each tab button is sized to accommodate its content. |
Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or aligned to the left. |
text | The text for the tab. |
control |
Bindable components implement this interface. |
Controls that support drag & drop operations implement this interface. |
Provides access to common image properties across the controls that implement this interface. |
All wisej components implement this interface. |
Allows an object to serialize itself. |
sender | The source of the event. |
e |
Occurs before a tab is selected, enabling a handler to cancel the tab change. |
Occurs before a tab is closed by the user, enabling a handler to cancel the tab closing. |
Occurs before a tab is deselected, enabling a handler to cancel the tab change. |
Tab buttons are centered within the width of the .
The width of each tab button is sized to fill the entire width of the .
Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or use the size set in .
The to look for.
All wisej controls derived from the class must implement this interface.
A that contains the event data.
Wisej.Web.TabControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.1.0.0)
Throws:
Throws:
Makes the tab following the tab with the specified index the current tab.
Throws:
Throws:
Makes the tab following the tab with the specified name the current tab.
Throws:
Throws:
Makes the tab with the specified index the current tab.
Throws:
Throws:
Makes the tab with the specified name the current tab.
Throws:
Manages a related set of pages.
Initializes a new instance of the class.
: 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
)
: 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.
: 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.
: 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.
: Returns the collection of tab pages in this tab control.
Parameter | Type | Description |
---|
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.
Parameter | Type | Description |
---|
tabPage is null.
Parameter | Type | Description |
---|
tabPageName is null; or tabPageName does not match the property of any in the collection.
Returns the control at the specified location.
Parameter | Type | Description |
---|
Returns: . The at the specified location.
index is less than 0 or greater than the number of controls in the collection minus 1.
Returns the bounding rectangle for the tab button of the at the specified index in this control.
Parameter | Type | Description |
---|
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.
Parameter | Type | Description |
---|
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.
Parameter | Type | Description |
---|
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 .
Parameter | Type | Description |
---|
index is less than 0 or greater than the number of controls in the collection minus 1.
Makes the specified the current tab.
Parameter | Type | Description |
---|
tabPage is null.
Parameter | Type | Description |
---|
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.
Occurs after a tab is shown or hidden by the user through the or programmatically through the property.
Name | Description |
---|
index |
tabPage |
tabPageName |
index |
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. |
index |
tabPage |
tabPageName |
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. |
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 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.