Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Loading...
Wisej.Web.TabControlCancelEventHandler
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents the method that will handle the Selecting or Deselecting event of a TabControl control.
| Name | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
Wisej.Web.TabControlCancelEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the and events of a control.
Initializes a new instance of the class.
| Name | Type | Description |
|---|
Initializes a new instance of the class.
| Name | Type | Description |
|---|
Wisej.Web.TabControl TabPageCollection
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
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.
Throws:
index is less than zero or greater than the highest available index.
value is null.
: Returns the with the specified key from the collection.
Throws:
Throws:
Throws:
Throws:
Throws:
Throws:
Wisej.Web.TabControlEventArgs
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Provides data for the and events of a control.
Initializes a new instance of the class.
| Name | Type | Description |
|---|
: Returns a value indicating which event is occurring.
: Returns a value indicating which event is occurring.
: Returns the zero-based index of the being selected when processing otherwise it returns -1.
: Returns the the event is occurring for.
: Returns the zero-based index of the being selected when processing and , or being deselected when processing and .
| Name | Description |
|---|
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 |
|---|
: Returns the the event is occurring for.
: Returns the zero-based index of the in the collection.
| Name | Description |
|---|
sender
The source of the event.
e
A TabControlCancelEventArgs that contains the event data.
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.
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 |
sender | The source of the event. |
e | A 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 or programmatically through the property. |
Fired when a tab is selected. |
Fired when a tab is deselected. |
Fired when the user drags a into a new position and the property is set to true. |
Closed | Represents the event. |
Closing | Represents the event. |
Deselected | Represents the event. |
Deselecting | Represents the event. |
Moved | Represents the event. |
Selected | Represents the event. |
Selecting | Represents the event. |
VisibilityChanged | Represents the event. |
Returns a value indicating which event is occurring. |
Returns a value indicating which event is occurring. |
tabPage |
tabPageIndex |
cancel | true to cancel the tab change by default; otherwise, false. |
action |
tabPage |
tabPageIndex |
newTabPageIndex |
cancel | true to cancel the tab change by default; otherwise, false. |
action |
tabPage |
tabPageIndex |
action |
Wisej.Web.TabControl
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Manages a related set of TabPage pages.
Initializes a new instance of the TabControl class.
Initializes a new instance of the TabControl class with the specified initial settings.
| Name | Type | Description |
|---|---|---|
Initializes a new instance of the TabControl class with the specified initial settings.
| Name | Type | Description |
|---|---|---|
Initializes a new instance of the TabControl class with the specified initial settings.
Initializes a new instance of the TabControl class with the specified initial settings.
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.
Int32: Returns the number of rows that are currently being displayed in the control's tab strip.
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.
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.
Int32: Gets the number of tabs in the tab strip.
TabPageCollection: Returns the collection of tab pages in this tab control.
Makes the tab following the tab with the specified index the current tab.
Throws:
ArgumentOutOfRangeException index 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.
Throws:
ArgumentNullException tabPage is null.
Makes the tab following the tab with the specified name the current tab.
Throws:
ArgumentNullException tabPageName is null; or tabPageName does not match the Name property of any TabPage in the TabPages collection.
Returns the TabPage control at the specified location.
Returns: Control. The TabPage at the specified location.
Throws:
ArgumentOutOfRangeException index is less than 0 or greater than the number of TabPage controls in the TabPages collection minus 1.
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.
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.
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.
Makes the tab with the specified index the current tab.
Throws:
ArgumentOutOfRangeException index 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.
Throws:
ArgumentNullException tabPage is null.
Makes the tab with the specified name the current tab.
Throws:
ArgumentNullException tabPageName 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.
Wisej.Web.TabSizeMode
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Specifies how tabs in a TabControl are sized.
| Name | Description |
|---|---|
| Name | Description |
|---|---|
Represents the method that will handle the or event of a control.
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.
Represents the method that will handle the or event of a control.
The the event is occurring for.
The zero-based index of tabPage in the collection.
One of the values.
The the event is occurring for.
The zero-based index of tabPage in the collection.
The zero-based index of tabPage in the collection.
One of the values.
The the event is occurring for.
The zero-based index of tabPage in the collection.
One of the values.
| Name | Type | Description |
|---|---|---|
| Name | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Parameter | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
location
The location of the TabControl on its parent control.
size
The size of the TabControl.
tabPages
An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
index
The index in the TabPages collection of the tab to deselect.
tabPage
The TabPage to deselect.
tabPageName
The Name of the tab to deselect.
index
The index of the TabPage to get.
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
The index in the TabPages collection of the tab to select.
tabPage
The TabPage to select.
tabPageName
The Name of the tab to select.
Bindable components implement this interface.
Controls that support drag & drop operations implement this interface.
All wisej components implement this interface.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
Center
Tab buttons are centered within the width of the TabControl.
Fill
The width of each tab button is sized to fill the entire width of the TabControl.
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 use the size set in ItemSize.
Returns or sets whether the tab buttons should fill the control's size, or placed in the center, or aligned to the left.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
tabPages
An array of TabPage objects to be added to the TabControl.
onSelectedIndexChanged
An Action delegate to handle the SelectedIndexChanged event.
Wisej.Web.TabPage
Namespace: Wisej.Web
Assembly: Wisej.Framework (3.5.0.0)
Represents a single tab page in a TabControl.
Initializes a new instance of the TabPage class.
Initializes a new instance of the TabPage class and specifies the text to display as the title the tab.
| Name | Type | Description |
|---|---|---|
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: Returns or sets the case of the text to display to the user. (Default: Normal)
Boolean: Returns or sets whether the TabPage is visible in the parent TabControl. (Default: False)
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.
String: Returns or sets the key accessor for the image in the ImageList of the associated TabControl. (Default: "")
Boolean: Returns or sets a value indicating that the tab can show the close button next to the name. (Default: False)
Boolean: Returns or sets whether the tab page should be included in the visibility menu. (Default: True)
Color: Returns or sets the background color of the TabPage tab button. (Default: Color [Empty])
TabControl: Returns the parent TabControl.
Color: Returns or sets the text color of the TabPage tab button. (Default: Color [Empty])
String: Returns or sets the text to display on the tab. (Default: "")
String: Returns or sets the ToolTip text for this tab. (Default: "")
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)
Boolean: Returns or sets whether the control and all its child controls are displayed.
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.
Returns the bounding rectangle for a specified tab in this tab control.
Returns: Rectangle. A Rectangle that represents the bounds of the specified tab.
Overridden to update the parent TabControl when in design mode.
EventHandler Fired when the value of the Text property changes.
| Parameter | Type | Description |
|---|---|---|
| Name | Description |
|---|---|
control
The Control to look for.
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.
All wisej controls derived from the Control class must implement this interface.
Allows an object to serialize itself.
text
The text for the tab.
