TabControlEventArgs Class

 

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

Namespace:   System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

System.Object
  System.EventArgs
    System.Windows.Forms.TabControlEventArgs

public class TabControlEventArgs : EventArgs

NameDescription
System_CAPS_pubmethodTabControlEventArgs(TabPage, Int32, TabControlAction)

Initializes a new instance of the TabControlEventArgs class.

NameDescription
System_CAPS_pubpropertyAction

Gets a value indicating which event is occurring.

System_CAPS_pubpropertyTabPage

Gets the TabPage the event is occurring for.

System_CAPS_pubpropertyTabPageIndex

Gets the zero-based index of the TabPage in the TabControl.TabPages collection.

NameDescription
System_CAPS_pubmethodEquals(Object)

Determines whether the specified object is equal to the current object.(Inherited from Object.)

System_CAPS_protmethodFinalize()

Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.(Inherited from Object.)

System_CAPS_pubmethodGetHashCode()

Serves as the default hash function. (Inherited from Object.)

System_CAPS_pubmethodGetType()

Gets the Type of the current instance.(Inherited from Object.)

System_CAPS_protmethodMemberwiseClone()

Creates a shallow copy of the current Object.(Inherited from Object.)

System_CAPS_pubmethodToString()

Returns a string that represents the current object.(Inherited from Object.)

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.

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

The following code example demonstrates the use of this type. In the example, an event handler reports on the occurrence of the Selected 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 Selected event.

private void TabControl1_Selected(Object sender, TabControlEventArgs 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();
MessageBox.Show(messageBoxCS.ToString(), "Selected Event" );
}

.NET Framework
Available since 2.0

Any public static (Shared in Visual Basic) members of this type are thread safe. Any instance members are not guaranteed to be thread safe.

Return to top
Show: