ToolTip Klasa

Definicja

Przestrzeń nazw:

System.Windows.Forms

Zestaw:

System.Windows.Forms.dll

Źródło:

ToolTip.cs

Reprezentuje małe prostokątne okno podręczne, które wyświetla krótki opis celu kontrolki, gdy użytkownik spoczywa wskaźnik w kontrolce.

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

Dziedziczenie

Object

MarshalByRefObject

Component

ToolTip

Implementuje

IExtenderProvider

Przykłady

Poniższy przykład kodu tworzy wystąpienie ToolTip klasy i kojarzy wystąpienie z Form wystąpieniem, w ramach którego jest tworzone wystąpienie. Następnie kod inicjuje właściwości AutoPopDelayopóźnienia , InitialDelayi ReshowDelay. Ponadto wystąpienie ToolTip klasy ustawia ShowAlways właściwość , aby true umożliwić wyświetlanie tekstu etykietki narzędzia, niezależnie od tego, czy formularz jest aktywny. Na koniec przykład kojarzy tekst Etykietki narzędzia z dwoma kontrolkami w formularzu, a Button i CheckBox. Przykład kodu wymaga, aby metoda zdefiniowana w przykładzie znajdowała się w obiekcie zawierającym kontrolkę Button o nazwie i kontrolce CheckBox o nazwie button1checkBox1, a metoda jest wywoływana z konstruktora Formklasy .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

Uwagi

ToolTip Dzięki klasie można podać wskazówki dla użytkownika, gdy użytkownik umieszcza wskaźnik w kontrolce. Klasa ToolTip jest zwykle używana do powiadamiania użytkowników o zamierzonym użyciu kontrolki. Można na przykład określić tekst etykietki narzędzia dla TextBox kontrolki, która akceptuje nazwę, określając format nazwy, która ma zostać wpisana do kontrolki. Oprócz podawania wskazówek można również użyć ToolTip klasy , aby podać informacje o stanie czasu wykonywania. Na przykład można użyć ToolTip klasy , aby wyświetlić dane dotyczące szybkości połączenia i jakości linii, gdy użytkownik przenosi wskaźnik do PictureBox kontrolki, która wyświetla stan połączenia internetowego.

Klasa ToolTip może być używana w dowolnym kontenerze. Aby jawnie określić kontener, użyj konstruktora ToolTip(IContainer) . ToolTip Jeden składnik jest zwykle używany do tworzenia etykietek narzędzi dla wielu kontrolek w jednym formularzu. Po utworzeniu ToolTipelementu użyj oddzielnego wywołania metody , SetToolTip aby skojarzyć tekst wyświetlania etykietki narzędzia z pojedynczą kontrolką. Następnie, gdy użytkownik przenosi wskaźnik w kontrolce, zostanie wyświetlona etykietka narzędzia z jego tekstem. Możesz wywołać SetToolTip więcej niż raz dla tej samej kontrolki, aby zmienić tekst skojarzony z kontrolką. Aby uzyskać tekst skojarzony z kontrolką, użyj GetToolTip metody . Aby usunąć wszystkie skojarzenia tekstu etykietki narzędzia z wystąpieniem ToolTip klasy, użyj RemoveAll metody .

Uwaga / Notatka

Tekst etykietki narzędzia nie jest wyświetlany dla kontrolek, które są wyłączone. Jeśli właściwość nie jest ustawiona ShowAlways na true, etykietki narzędzi nie są wyświetlane, gdy kontener jest nieaktywny.

Klasa ToolTip udostępnia następujące właściwości i metody modyfikowania domyślnego zachowania i wyglądu etykietki narzędzia.

Kategoria	Skojarzone elementy członkowskie
Wyświetlanie ręczne	Active, , Show, Hide, ShowAlways, , PopupStopTimer
Czas etykietki narzędzia	AutoPopDelay, , InitialDelay, ReshowDelay, , AutomaticDelayStopTimer
Content	SetToolTip, , GetToolTip, StripAmpersands, ToolTipIcon, , ToolTipTitleRemoveAll
Wygląd	BackColor, , ForeColor, IsBalloon, OwnerDraw, , UseAnimationUseFading

Jeśli chcesz wyłączyć cały tekst etykietki narzędzia, aby nie można było go wyświetlić w aplikacji, możesz użyć Active właściwości . Zazwyczaj etykietka narzędzia jest rysowana przez system operacyjny, ale w celu dostosowania wyglądu ToolTipelementu można ustawić OwnerDraw właściwość na true i obsłużyć Draw zdarzenie.

Klasa ToolTipTitle implementuje System.ComponentModel.IExtenderProvider interfejs, który ma jedną metodę CanExtend. Etykietki narzędzi rozszerzają kontrolki na tym samym formularzu w czasie projektowania, dodając ToolTip właściwość. Aby uzyskać więcej informacji na temat dostawców rozszerzenia, zobacz Dostawcy rozszerzenia.

Konstruktory

Nazwa	Opis
ToolTip()	Inicjuje nowe wystąpienie ToolTip obiektu bez określonego kontenera.
ToolTip(IContainer)	Inicjuje nowe wystąpienie ToolTip klasy z określonym kontenerem.

Właściwości

Nazwa	Opis
Active	Pobiera lub ustawia wartość wskazującą, czy etykietka narzędzia jest obecnie aktywna.
AutomaticDelay	Pobiera lub ustawia automatyczne opóźnienie dla etykietki narzędzia.
AutoPopDelay	Pobiera lub ustawia okres czasu etykietka narzędzia pozostaje widoczna, jeśli wskaźnik jest nieruchomy na kontrolce z określonym tekstem etykietki narzędzia.
BackColor	Pobiera lub ustawia kolor tła etykietki narzędzia.
CreateParams	Pobiera parametry tworzenia okna Etykietka narzędzia.
ForeColor	Pobiera lub ustawia kolor pierwszego planu dla etykietki narzędzia.
InitialDelay	Pobiera lub ustawia czas, który przechodzi przed wyświetleniem etykietki narzędzia.
IsBalloon	Pobiera lub ustawia wartość wskazującą, czy etykietka narzędzia powinna używać okna balonu.
OwnerDraw	Pobiera lub ustawia wartość wskazującą, czy etykietka narzędzia jest rysowana przez system operacyjny, czy przez kod, który podajesz.
ReshowDelay	Pobiera lub ustawia czas, który musi się pojawić przed wyświetleniem kolejnych okien Etykietka narzędzia, gdy wskaźnik przechodzi z jednej kontrolki do innej.
ShowAlways	Pobiera lub ustawia wartość wskazującą, czy jest wyświetlane okno Etykietka narzędzia, nawet jeśli jego kontrolka nadrzędna nie jest aktywna.
StripAmpersands	Pobiera lub ustawia wartość, która określa, jak są traktowane znaki ampersand (&).
Tag	Pobiera lub ustawia obiekt zawierający dane dostarczone przez programistę skojarzone z elementem ToolTip.
ToolTipIcon	Pobiera lub ustawia wartość, która definiuje typ ikony, która ma być wyświetlana obok tekstu Etykietka narzędzia.
ToolTipTitle	Pobiera lub ustawia tytuł okna Etykietka narzędzia.
UseAnimation	Pobiera lub ustawia wartość określającą, czy podczas wyświetlania etykietki narzędzia ma być używany efekt animacji.
UseFading	Pobiera lub ustawia wartość określającą, czy podczas wyświetlania etykietki narzędzia należy użyć efektu zanikania.

Metody

Nazwa	Opis
CanExtend(Object)	Zwraca wartość true , jeśli etykietka narzędzia może oferować właściwość rozszerzenia do określonego składnika docelowego.
Dispose(Boolean)	Zwalnia niezarządzane zasoby używane przez Component program i opcjonalnie zwalnia zarządzane zasoby.
Finalize()	Zwalnia niezarządzane zasoby i wykonuje inne operacje oczyszczania przed Cursor odzyskaniem przez moduł odśmiecanie pamięci.
GetToolTip(Control)	Pobiera tekst etykietki narzędzia skojarzony z określoną kontrolką.
Hide(IWin32Window)	Ukrywa określone okno Etykietka narzędzia.
RemoveAll()	Usuwa cały tekst etykietki narzędzia skojarzony obecnie ze składnikiem Etykietka narzędzia.
SetToolTip(Control, String)	Kojarzy tekst etykietki narzędzia z określoną kontrolką.
Show(String, IWin32Window, Int32, Int32, Int32)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką, a następnie wyświetla etykietkę narzędzia dla określonego czasu trwania w określonej pozycji względnej.
Show(String, IWin32Window, Int32, Int32)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką, a następnie wyświetla etykietkę narzędzia modalnie w określonej pozycji względnej.
Show(String, IWin32Window, Int32)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką, a następnie wyświetla etykietkę narzędzia dla określonego czasu trwania.
Show(String, IWin32Window, Point, Int32)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką, a następnie wyświetla etykietkę narzędzia dla określonego czasu trwania w określonej pozycji względnej.
Show(String, IWin32Window, Point)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką, a następnie wyświetla etykietkę narzędzia modalnie w określonej pozycji względnej.
Show(String, IWin32Window)	Ustawia tekst etykietki narzędzia skojarzony z określoną kontrolką i wyświetla etykietkę narzędzia modalnie.
StopTimer()	Zatrzymuje czasomierz, który ukrywa wyświetlane etykietki narzędzi.
ToString()	Zwraca reprezentację ciągu dla tej kontrolki.

Zdarzenia

Nazwa	Opis
Draw	Występuje, gdy etykietka narzędzia jest rysowana, a OwnerDraw właściwość jest ustawiona na true , a IsBalloon właściwość to false.
Popup	Występuje przed początkowym wyświetleniem etykietki narzędzia. Jest to domyślne zdarzenie dla ToolTip klasy.

Zobacz też

• ToolTipIcon
• HelpProvider
• Dostawcy rozszerzenia
• ToolTip — Składnik (Formularze systemu Windows)