ToolTip Třída

Definice

Obor názvů:

System.Windows.Forms

Sestavení:

System.Windows.Forms.dll

Zdroj:

ToolTip.cs

Představuje malé obdélníkové automaticky otevírané okno, které zobrazuje stručný popis účelu ovládacího prvku, když uživatel umístí ukazatel myši na ovládací prvek.

public ref class ToolTip : System::ComponentModel::Component, System::ComponentModel::IExtenderProvider

public class ToolTip : System.ComponentModel.Component, System.ComponentModel.IExtenderProvider

type ToolTip = class
    inherit Component
    interface IExtenderProvider

Public Class ToolTip
Inherits Component
Implements IExtenderProvider

Dědičnost

Object

MarshalByRefObject

Component

ToolTip

Implementuje

IExtenderProvider

Příklady

Následující příklad kódu vytvoří instanci ToolTip třídy a přidruží instanci k Form instanci, ve které je instance vytvořena. Kód pak inicializuje vlastnosti AutoPopDelayzpoždění , InitialDelaya ReshowDelay. Kromě instance ToolTip třídy nastaví ShowAlways vlastnost tak, aby true byl text popisu vždy zobrazen bez ohledu na to, zda je formulář aktivní. A konečně příklad přidruží text popisu k dvěma ovládacím prvkům ve formuláři a Button a CheckBox. Příklad kódu vyžaduje, aby metoda definovaná v příkladu je umístěna uvnitř Form , který obsahuje Button ovládací prvek s názvem button1 a CheckBox s názvem checkBox1ovládacího prvku , a že metoda je volána z konstruktoru Form.

// This example assumes that the Form_Load event handling method
// is connected to the Load event of the form.
void Form1_Load( Object^ sender, System::EventArgs^ e )
{
   // Create the ToolTip and associate with the Form container.
   ToolTip^ toolTip1 = gcnew ToolTip;
   
   // Set up the delays for the ToolTip.
   toolTip1->AutoPopDelay = 5000;
   toolTip1->InitialDelay = 1000;
   toolTip1->ReshowDelay = 500;
   // Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1->ShowAlways = true;
   
   // Set up the ToolTip text for the Button and Checkbox.
   toolTip1->SetToolTip( this->button1, "My button1" );
   toolTip1->SetToolTip( this->checkBox1, "My checkBox1" );
}

// This example assumes that the Form_Load event handling method
// is connected to the Load event of the form.
private void Form1_Load(object sender, System.EventArgs e)
{
   // Create the ToolTip and associate with the Form container.
   ToolTip toolTip1 = new ToolTip();

   // Set up the delays for the ToolTip.
   toolTip1.AutoPopDelay = 5000;
   toolTip1.InitialDelay = 1000;
   toolTip1.ReshowDelay = 500;
   // Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1.ShowAlways = true;
      
   // Set up the ToolTip text for the Button and Checkbox.
   toolTip1.SetToolTip(this.button1, "My button1");
   toolTip1.SetToolTip(this.checkBox1, "My checkBox1");
}

' This example assumes that the Form_Load event handling method
' is connected to the Load event of the form.
Private Sub Form1_Load(sender As Object, e As System.EventArgs) Handles MyBase.Load
   ' Create the ToolTip and associate with the Form container.
   Dim toolTip1 As New ToolTip()
   
   ' Set up the delays for the ToolTip.
   toolTip1.AutoPopDelay = 5000
   toolTip1.InitialDelay = 1000
   toolTip1.ReshowDelay = 500
   ' Force the ToolTip text to be displayed whether or not the form is active.
   toolTip1.ShowAlways = True
   
   ' Set up the ToolTip text for the Button and Checkbox.
   toolTip1.SetToolTip(Me.button1, "My button1")
   toolTip1.SetToolTip(Me.checkBox1, "My checkBox1")
End Sub

Poznámky

ToolTip Pomocí třídy můžete uživateli poskytnout rady, když uživatel umístí ukazatel na ovládací prvek. Třída ToolTip se obvykle používá k upozorňování uživatelů na zamýšlené použití ovládacího prvku. Můžete například zadat text popisu pro TextBox ovládací prvek, který přijímá název, a zadat formát názvu, který má být zadán do ovládacího prvku. Kromě poskytování tipů můžete také pomocí ToolTip třídy poskytnout informace o stavu běhu. Třídu můžete například použít ToolTip k zobrazení dat o rychlosti připojení a kvalitě čar, když uživatel přesune ukazatel na PictureBox ovládací prvek, který zobrazuje stav připojení k internetu.

Třídu ToolTip lze použít v libovolném kontejneru. Pokud chcete explicitně zadat kontejner, použijte ToolTip(IContainer) konstruktor. Jedna ToolTip komponenta se obvykle používá k vytvoření popisů pro více ovládacích prvků v jednom formuláři. Po vytvoření ToolTipmetody použijte samostatné volání SetToolTip metody pro přidružení zobrazovaného textu popisu k jednotlivým ovládacím prvkům. Když uživatel přesune ukazatel na ovládací prvek, zobrazí se popis s textem. Pokud chcete změnit text přidružený k ovládacího prvku, můžete pro stejný ovládací prvek volat SetToolTip více než jednou. K získání textu přidruženého k ovládacímu prvku použijte metodu GetToolTip . Chcete-li odebrat všechna přidružení textu popisu k instanci ToolTip třídy, použijte metodu RemoveAll .

Poznámka:

Text popisu se nezobrazuje u ovládacích prvků, které jsou zakázané. Pokud není vlastnost nastavena ShowAlways na true, popisy tlačítek se nezobrazí, když je jejich kontejner neaktivní.

Třída ToolTip poskytuje následující vlastnosti a metody pro úpravu výchozího chování a vzhledu ToolTip.

Kategorie	Přidružené členy
Ruční zobrazení	Active, Show, Hide, ShowAlways, , PopupStopTimer
Časování popisů tlačítek	AutoPopDelay, InitialDelay, ReshowDelay, , AutomaticDelayStopTimer
Content	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, , ToolTipTitleRemoveAll
Vzhled	BackColor, ForeColor, IsBalloon, OwnerDraw, , UseAnimationUseFading

Pokud chcete zakázat veškerý text popisu, aby ho nelze zobrazit v aplikaci, můžete použít Active vlastnost. Popis je obvykle vykreslen operačním systémem, ale pro přizpůsobení vzhledu ToolTip, můžete nastavit OwnerDraw vlastnost na true a zpracovat Draw událost.

Třída ToolTipTitle implementuje System.ComponentModel.IExtenderProvider rozhraní, které má jednu metodu, CanExtend. Popisy tlačítek rozšiřují ovládací prvky ve stejném formuláři v době návrhu ToolTip a přidávají vlastnost. Další informace o poskytovateli extenderu naleznete v tématu Extender Providers.

Konstruktory

Name	Description
ToolTip()	Inicializuje novou instanci ToolTip bez zadaného kontejneru.
ToolTip(IContainer)	Inicializuje novou instanci ToolTip třídy se zadaným kontejnerem.

Vlastnosti

Name	Description
Active	Získá nebo nastaví hodnotu označující, zda je popis aktuálně aktivní.
AutomaticDelay	Získá nebo nastaví automatické zpoždění popisu.
AutoPopDelay	Získá nebo nastaví časové období, po který zůstane popisek viditelný, pokud je ukazatel na ovládacím prvku se zadaným textem popisu.
BackColor	Získá nebo nastaví barvu pozadí pro popis.
CreateParams	Získá parametry vytvoření pro okno Popis.
ForeColor	Získá nebo nastaví barvu popředí pro popis.
InitialDelay	Získá nebo nastaví čas, který se předá, než se zobrazí popis.
IsBalloon	Získá nebo nastaví hodnotu označující, zda má popis použít okno bubliny.
OwnerDraw	Získá nebo nastaví hodnotu označující, zda je popis vykreslen operačním systémem nebo kódem, který zadáte.
ReshowDelay	Získá nebo nastaví dobu, která se musí překládat před následnými okny popisů, jak se ukazatel pohybuje od jednoho ovládacího prvku k druhému.
ShowAlways	Získá nebo nastaví hodnotu označující, zda je zobrazeno okno Popis, i když jeho nadřazený ovládací prvek není aktivní.
StripAmpersands	Získá nebo nastaví hodnotu, která určuje, jak se znaky ampersand (&) zachází.
Tag	Získá nebo nastaví objekt, který obsahuje programátor-zadaný data přidružena k ToolTip.
ToolTipIcon	Získá nebo nastaví hodnotu, která definuje typ ikony, která se má zobrazit spolu s textem popisku.
ToolTipTitle	Získá nebo nastaví název pro okno Popis.
UseAnimation	Získá nebo nastaví hodnotu určující, zda se má použít animační efekt při zobrazení popisu.
UseFading	Získá nebo nastaví hodnotu určující, zda se má použít efekt prolnutí při zobrazení popisu.

Metody

Name	Description
CanExtend(Object)	Vrátí true , pokud toolTip může nabídnout rozšiřující vlastnost pro zadanou cílovou komponentu.
Dispose(Boolean)	Uvolní nespravované prostředky používané Component a volitelně uvolní spravované prostředky.
Finalize()	Uvolní nespravované prostředky a provede další operace čištění před Cursor uvolněním paměti uvolňováním paměti.
GetToolTip(Control)	Načte text popisu, který je přidružený k zadanému ovládacímu prvku.
Hide(IWin32Window)	Skryje zadané okno popisku.
RemoveAll()	Odebere veškerý text popisu, který je aktuálně přidružený ke komponentě ToolTip.
SetToolTip(Control, String)	Přidruží text popisu k zadanému ovládacímu prvku.
Show(String, IWin32Window, Int32, Int32, Int32)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a potom zobrazí popis pro zadanou dobu trvání na zadané relativní pozici.
Show(String, IWin32Window, Int32, Int32)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a pak zobrazí popis v zadané relativní pozici modálně.
Show(String, IWin32Window, Int32)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a potom zobrazí popis pro zadanou dobu trvání.
Show(String, IWin32Window, Point, Int32)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a potom zobrazí popis pro zadanou dobu trvání na zadané relativní pozici.
Show(String, IWin32Window, Point)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a pak zobrazí popis v zadané relativní pozici modálně.
Show(String, IWin32Window)	Nastaví text popisu přidružený k zadanému ovládacímu prvku a zobrazí modálně popis.
StopTimer()	Zastaví časovač, který skryje zobrazené popisy.
ToString()	Vrátí řetězcovou reprezentaci pro tento ovládací prvek.

Událost

Name	Description
Draw	Nastane, když je popis nakreslen a OwnerDraw vlastnost je nastavena true a IsBalloon vlastnost je false.
Popup	Nastane před počátečním zobrazením popisu. Toto je výchozí událost třídy ToolTip .

Viz také

• ToolTipIcon
• HelpProvider
• Poskytovatelé extenderů
• ToolTip – komponenta (Windows Forms)