TabControlCancelEventArgs Class

Reference

Definition

Namespace:: System.Windows.Forms

Assembly:: System.Windows.Forms.dll

Important

Some information relates to prerelease product that may be substantially modified before it’s released. Microsoft makes no warranties, express or implied, with respect to the information provided here.

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

public ref class TabControlCancelEventArgs : System::ComponentModel::CancelEventArgs

public class TabControlCancelEventArgs : System.ComponentModel.CancelEventArgs

type TabControlCancelEventArgs = class
    inherit CancelEventArgs

Public Class TabControlCancelEventArgs
Inherits CancelEventArgs

Inheritance: Object

EventArgs

CancelEventArgs
TabControlCancelEventArgs

Examples

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Selecting event. This report helps you to learn when the event occurs and can assist you in debugging. To report on multiple events or on events that occur frequently, consider replacing Show with Console.WriteLine or appending the message to a multiline TextBox.

To run the example code, paste it into a project that contains an instance of type TabControl named TabControl1. Then ensure that the event handler is associated with the Selecting event.

private void TabControl1_Selecting(Object sender, TabControlCancelEventArgs e) {

System.Text.StringBuilder messageBoxCS = new System.Text.StringBuilder();
messageBoxCS.AppendFormat("{0} = {1}", "TabPage", e.TabPage );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "TabPageIndex", e.TabPageIndex );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Action", e.Action );
messageBoxCS.AppendLine();
messageBoxCS.AppendFormat("{0} = {1}", "Cancel", e.Cancel );
messageBoxCS.AppendLine();
MessageBox.Show(messageBoxCS.ToString(), "Selecting Event" );
}

Private Sub TabControl1_Selecting(sender as Object, e as TabControlCancelEventArgs) _ 
     Handles TabControl1.Selecting

    Dim messageBoxVB as New System.Text.StringBuilder()
    messageBoxVB.AppendFormat("{0} = {1}", "TabPage", e.TabPage)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "TabPageIndex", e.TabPageIndex)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Action", e.Action)
    messageBoxVB.AppendLine()
    messageBoxVB.AppendFormat("{0} = {1}", "Cancel", e.Cancel)
    messageBoxVB.AppendLine()
    MessageBox.Show(messageBoxVB.ToString(),"Selecting Event")

End Sub

Remarks

Use the Action property to determine which event is occurring. This enables you to handle multiple event types with one event handler.

Use the TabPage and TabPageIndex properties to determine which TabPage the event is occurring for.

To cancel a tab change in a TabControl, set the Cancel property to true.

For more information about handling events, see Handling and Raising Events.

Constructors

TabControlCancelEventArgs(TabPage, Int32, Boolean, TabControlAction)

Initializes a new instance of the TabControlCancelEventArgs class.

Properties

Action	Gets a value indicating which event is occurring.
Cancel	Gets or sets a value indicating whether the event should be canceled. (Inherited from CancelEventArgs)
TabPage	Gets the TabPage the event is occurring for.
TabPageIndex	Gets the zero-based index of the TabPage in the TabPages collection.

Methods

Equals(Object)	Determines whether the specified object is equal to the current object. (Inherited from Object)
GetHashCode()	Serves as the default hash function. (Inherited from Object)
GetType()	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone()	Creates a shallow copy of the current Object. (Inherited from Object)
ToString()	Returns a string that represents the current object. (Inherited from Object)

Applies to

Share via