TabPage.ToolTipText Property

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Gets or sets the ToolTip text for this tab.

public:
 property System::String ^ ToolTipText { System::String ^ get(); void set(System::String ^ value); };

public string ToolTipText { get; set; }

member this.ToolTipText : string with get, set

Public Property ToolTipText As String

Property Value

String

The ToolTip text for this tab.

Examples

The following code example creates a TabControl with two TabPage objects. The TabControl is set to allow ToolTips, and the tab pages are assigned ToolTip text.

using namespace System::Drawing;
using namespace System::Windows::Forms;
public ref class Form1: public Form
{
private:
   TabControl^ tabControl1;
   TabPage^ tabPage1;
   TabPage^ tabPage2;
   void MyTabs()
   {
      this->tabControl1 = gcnew TabControl;
      this->tabPage1 = gcnew TabPage;
      this->tabPage2 = gcnew TabPage;
      array<Control^>^tabPages = {this->tabPage1,this->tabPage2};
      this->tabControl1->Controls->AddRange( tabPages );
      this->tabControl1->Location = Point(35,25);
      this->tabControl1->Size = System::Drawing::Size( 220, 220 );
      
      // Shows ToolTipText when the mouse passes over tabs.
      this->tabControl1->ShowToolTips = true;
      
      // Assigns String* values to ToolTipText.
      this->tabPage1->ToolTipText = "myTabPage1";
      this->tabPage2->ToolTipText = "myTabPage2";
      this->Size = System::Drawing::Size( 300, 300 );
      array<Control^>^formControls = {this->tabControl1};
      this->Controls->AddRange( formControls );
   }


public:
   Form1()
   {
      MyTabs();
   }

};

int main()
{
   Application::Run( gcnew Form1 );
}

using System.Drawing;
using System.Windows.Forms;

public class Form1 : Form
{
    private TabControl tabControl1;
    private TabPage tabPage1;
    private TabPage tabPage2;

    private void MyTabs()
    {
        this.tabControl1 = new TabControl();
        this.tabPage1 = new TabPage();
        this.tabPage2 = new TabPage();

        this.tabControl1.Controls.AddRange(new Control[] {
            this.tabPage1,
            this.tabPage2});
        this.tabControl1.Location = new Point(35, 25);
        this.tabControl1.Size = new Size(220, 220);

        // Shows ToolTipText when the mouse passes over tabs.
        this.tabControl1.ShowToolTips = true;

        // Assigns string values to ToolTipText.
        this.tabPage1.ToolTipText = "myTabPage1";
        this.tabPage2.ToolTipText = "myTabPage2";

        this.Size = new Size(300, 300);
        this.Controls.AddRange(new Control[] {
            this.tabControl1});
    }
    
    public Form1()
    {
        MyTabs();
    }

    static void Main() 
    {
        Application.Run(new Form1());
    }
}

Imports System.Drawing
Imports System.Windows.Forms

Public Class Form1
    Inherits Form
    Private tabControl1 As TabControl
    Private tabPage1 As TabPage
    Private tabPage2 As TabPage

    Private Sub MyTabs()
        Me.tabControl1 = New TabControl()
        Me.tabPage1 = New TabPage()
        Me.tabPage2 = New TabPage()

        Me.tabControl1.Controls.AddRange(New Control() {Me.tabPage1, Me.tabPage2})
        Me.tabControl1.Location = New Point(35, 25)
        Me.tabControl1.Size = New Size(220, 220)

        ' Shows ToolTipText when the mouse passes over tabs.
        Me.tabControl1.ShowToolTips = True

        ' Assigns string values to ToolTipText.
        Me.tabPage1.ToolTipText = "myTabPage1"
        Me.tabPage2.ToolTipText = "myTabPage2"

        Me.Size = New Size(300, 300)
        Me.Controls.AddRange(New Control() {Me.tabControl1})
    End Sub

    Public Sub New()
        MyTabs()
    End Sub

    Shared Sub Main()
        Application.Run(New Form1())
    End Sub
End Class

Remarks

This tab page belongs to a TabControl. The ToolTip text appears when the user moves the mouse over the tab if the ShowToolTips property of the TabControl is true. For more information about ToolTips, see the ToolTip class.

See also

• TabControl
• ToolTip