TabControlCancelEventArgs.TabPageIndex Property

 

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

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

public int TabPageIndex { get; }

Property Value

Type: System.Int32

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

The following code example demonstrates the use of this member. In the example, an event handler reports on the occurrence of the TabControl.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 MessageBox.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 TabControl.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" );
}

.NET Framework
Available since 2.0
Return to top
Show: