Returns the bounding rectangle for a specified tab in this tab control.
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Syntax . . :: . Rectangle
A Rectangle that represents the bounds of the specified tab.
Public Function GetTabRect ( _
index As Integer _
) As Rectanglepublic Rectangle GetTabRect(
int index
)public:
Rectangle GetTabRect(
int index
)member GetTabRect :
index:int -> Rectangle
Parameters
- index
- Type: System
. . :: . Int32
The zero-based index of the tab you want.
Return Value
Type: System.DrawingA Rectangle that represents the bounds of the specified tab.
Exceptions
| Exception | Condition |
|---|---|
| ArgumentOutOfRangeException | The index is less than zero. -or- The index is greater than or equal to Count. |
Examples
The following code example creates a TabControl with one TabPage. This example uses the GetTabRect method to get a Rectangle that represents the tabPage1 tab area. The myTabRectRectangle is drawn by the DrawItem event.
Use the System.Drawing and System.Windows.Forms namespaces with this example.
Imports System.Drawing
Imports System.Windows.Forms
Public Class Form1
Inherits Form
Private tabControl1 As TabControl
Private myTabRect As Rectangle
Public Sub New()
tabControl1 = New TabControl()
Dim tabPage1 As New TabPage()
tabControl1.Controls.Add(tabPage1)
tabControl1.DrawMode = TabDrawMode.OwnerDrawFixed
tabControl1.Location = New Point(25, 25)
tabControl1.Size = New Size(250, 250)
tabPage1.TabIndex = 0
' Gets the tabPage1 tab area defined by its TabIndex.
' Returns a Rectangle to myTabRect.
myTabRect = tabControl1.GetTabRect(0)
ClientSize = New Size(300, 300)
Controls.Add(tabControl1)
AddHandler tabControl1.DrawItem, AddressOf OnDrawItem
End Sub
Private Sub OnDrawItem(ByVal sender As Object, ByVal e As DrawItemEventArgs)
Dim g As Graphics = e.Graphics
Dim p As New Pen(Color.Blue)
g.DrawRectangle(p, myTabRect)
End Sub
Shared Sub Main()
Application.Run(New Form1())
End Sub
End Class
using System.Drawing;
using System.Windows.Forms;
public class Form1 : Form
{
private TabControl tabControl1;
private Rectangle myTabRect;
public Form1()
{
tabControl1 = new TabControl();
TabPage tabPage1 = new TabPage();
tabControl1.Controls.Add(tabPage1);
tabControl1.DrawMode = TabDrawMode.OwnerDrawFixed;
tabControl1.Location = new Point(25, 25);
tabControl1.Size = new Size(250, 250);
tabPage1.TabIndex = 0;
// Gets the tabPage1 tab area defined by its TabIndex.
// Returns a Rectangle to myTabRect.
myTabRect = tabControl1.GetTabRect(0);
ClientSize = new Size(300, 300);
Controls.Add(tabControl1);
tabControl1.DrawItem += new DrawItemEventHandler(OnDrawItem);
}
private void OnDrawItem(object sender, DrawItemEventArgs e)
{
Graphics g = e.Graphics;
Pen p = new Pen(Color.Blue);
g.DrawRectangle(p, myTabRect);
}
static void Main()
{
Application.Run(new Form1());
}
}
using namespace System::Drawing;
using namespace System::Windows::Forms;
public ref class Form1: public Form
{
private:
TabControl^ tabControl1;
Rectangle myTabRect;
public:
Form1()
{
tabControl1 = gcnew TabControl;
TabPage^ tabPage1 = gcnew TabPage;
tabControl1->Controls->Add( tabPage1 );
tabControl1->DrawMode = TabDrawMode::OwnerDrawFixed;
tabControl1->Location = Point(25,25);
tabControl1->Size = System::Drawing::Size( 250, 250 );
tabPage1->TabIndex = 0;
// Gets the tabPage1 tab area defined by its TabIndex.
// Returns a Rectangle to myTabRect.
myTabRect = tabControl1->GetTabRect( 0 );
ClientSize = System::Drawing::Size( 300, 300 );
Controls->Add( tabControl1 );
tabControl1->DrawItem += gcnew DrawItemEventHandler( this, &Form1::OnDrawItem );
}
private:
void OnDrawItem( Object^ /*sender*/, DrawItemEventArgs^ e )
{
Graphics^ g = e->Graphics;
Pen^ p = gcnew Pen( Color::Blue );
g->DrawRectangle( p, myTabRect );
}
};
int main()
{
Application::Run( gcnew Form1 );
}
Platforms
Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2
The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.