ToolTip Класс

Определение

Пространство имен:

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

Исходный код:

ToolTip.cs

Представляет небольшое прямоугольное всплывающее окно, в котором отображается краткое описание назначения элемента управления, когда пользователь отдыхает указатель на элемент управления.

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

Наследование

Object

MarshalByRefObject

Component

ToolTip

Реализации

IExtenderProvider

Примеры

В следующем примере кода создается экземпляр класса и связывается экземпляр ToolTip с Form созданным экземпляром. Затем код инициализирует свойства AutoPopDelayзадержки и InitialDelayReshowDelay. Кроме того, экземпляр класса задает ShowAlways свойство, позволяющее true всегда отображать текст подсказки ToolTip независимо от того, активна ли форма. Наконец, в примере сопоставляется текст подсказки с двумя элементами управления в форме, a Button и a CheckBox. В примере кода требуется, чтобы метод, определенный в примере, находится в пределах Form элемента управления с именем button1 и CheckBox именем checkBox1элемента управления, а метод вызывается из конструктораForm.Button

// 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

Комментарии

ToolTip С помощью класса можно указать пользователю указания, когда пользователь помещает указатель на элемент управления. Класс ToolTip обычно используется для оповещения пользователей о предполагаемом использовании элемента управления. Например, можно указать текст подсказки для TextBox элемента управления, который принимает имя, указывая формат имени, который нужно ввести в элемент управления. Помимо указания, можно также использовать ToolTip класс для предоставления сведений о состоянии выполнения. Например, класс можно использовать ToolTip для отображения данных о скорости подключения и качества линии при перемещении указателя на элемент управления, отображающий состояние подключения к Интернету PictureBox .

Класс ToolTip можно использовать в любом контейнере. Чтобы явно указать контейнер, используйте ToolTip(IContainer) конструктор. Один ToolTip компонент обычно используется для создания подсказок для нескольких элементов управления в одной форме. После создания ToolTipиспользуйте отдельный вызов SetToolTip метода для связывания текста подсказки с отдельным элементом управления. Затем, когда пользователь перемещает указатель на элемент управления, отображается подсказка со своим текстом. Для одного элемента управления можно вызвать SetToolTip несколько раз, чтобы изменить текст, связанный с элементом управления. Чтобы получить текст, связанный с элементом управления, используйте GetToolTip метод. Чтобы удалить все связи текста подсказки с экземпляром ToolTip класса, используйте RemoveAll метод.

Замечание

Текст подсказки не отображается для элементов управления, которые отключены. Если ShowAlways свойство не задано true, подсказки не отображаются, если контейнер неактивен.

Класс ToolTip предоставляет следующие свойства и методы для изменения поведения и внешнего вида подсказки по умолчанию.

Категория	Связанные члены
Отображение вручную	Active, , ShowShowAlwaysHidePopup,StopTimer
Время подсказки	AutoPopDelay, InitialDelay, , ReshowDelay, AutomaticDelayStopTimer
Content	SetToolTip, , GetToolTipToolTipIconStripAmpersandsToolTipTitle,RemoveAll
Внешность	BackColor, , ForeColorOwnerDrawIsBalloonUseAnimation,UseFading

Если вы хотите отключить весь текст подсказки, чтобы его нельзя было отобразить в приложении, можно использовать Active это свойство. Обычно подсказка рисуется операционной системой, но для настройки внешнего вида ToolTipсвойства можно задать OwnerDraw для true свойства и обрабатывать Draw событие.

Класс ToolTipTitle реализует System.ComponentModel.IExtenderProvider интерфейс, имеющий один метод CanExtend. Подсказки расширяют элементы управления в той же форме во время разработки, добавляя ToolTip свойство. Дополнительные сведения о поставщиках расширений см. в разделе "Поставщики расширений".

Конструкторы

Имя	Описание
ToolTip()	Инициализирует новый экземпляр без указанного ToolTip контейнера.
ToolTip(IContainer)	Инициализирует новый экземпляр ToolTip класса с указанным контейнером.

Свойства

Имя	Описание
Active	Возвращает или задает значение, указывающее, активна ли подсказка в данный момент.
AutomaticDelay	Возвращает или задает автоматическую задержку для подсказки.
AutoPopDelay	Возвращает или задает период времени, когда подсказка остается видимой, если указатель находится на элементе управления с указанным текстом подсказки.
BackColor	Возвращает или задает цвет фона для подсказки.
CreateParams	Возвращает параметры создания для окна подсказки.
ForeColor	Возвращает или задает цвет переднего плана для подсказки.
InitialDelay	Возвращает или задает время, которое проходит до появления подсказки.
IsBalloon	Возвращает или задает значение, указывающее, должна ли подсказка использовать окно воздушных шаров.
OwnerDraw	Возвращает или задает значение, указывающее, рисуется ли подсказка операционной системой или предоставленным кодом.
ReshowDelay	Возвращает или задает период времени, который должен выполняться перед последующими окнами подсказки, как указатель перемещается из одного элемента управления в другой.
ShowAlways	Возвращает или задает значение, указывающее, отображается ли окно подсказки, даже если его родительский элемент управления не активен.
StripAmpersands	Возвращает или задает значение, определяющее, как обрабатываются амперсанды (>).
Tag	Возвращает или задает объект, содержащий предоставленные программистом данные, связанные с объектом ToolTip.
ToolTipIcon	Возвращает или задает значение, определяющее тип значка, отображаемого вместе с текстом подсказки.
ToolTipTitle	Возвращает или задает заголовок окна подсказки.
UseAnimation	Возвращает или задает значение, определяющее, следует ли использовать эффект анимации при отображении подсказки.
UseFading	Возвращает или задает значение, определяющее, следует ли использовать эффект затухания при отображении подсказки.

Методы

Имя	Описание
CanExtend(Object)	Возвращает, true может ли подсказка предложить свойство расширения указанному целевому компоненту.
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые Component и при необходимости освобождает управляемые ресурсы.
Finalize()	Освобождает неуправляемые ресурсы и выполняет другие операции очистки перед Cursor восстановлением сборщиком мусора.
GetToolTip(Control)	Извлекает текст подсказки, связанный с указанным элементом управления.
Hide(IWin32Window)	Скрывает указанное окно подсказки.
RemoveAll()	Удаляет весь текст подсказки, связанный с компонентом подсказки.
SetToolTip(Control, String)	Связывает текст подсказки с указанным элементом управления.
Show(String, IWin32Window, Int32, Int32, Int32)	Задает текст подсказки, связанный с указанным элементом управления, а затем отображает подсказку в течение указанной относительной позиции.
Show(String, IWin32Window, Int32, Int32)	Задает текст подсказки, связанный с указанным элементом управления, а затем отображает подсказку модально в указанной относительной позиции.
Show(String, IWin32Window, Int32)	Задает текст подсказки, связанный с указанным элементом управления, а затем отображает подсказку в течение указанной длительности.
Show(String, IWin32Window, Point, Int32)	Задает текст подсказки, связанный с указанным элементом управления, а затем отображает подсказку в течение указанной относительной позиции.
Show(String, IWin32Window, Point)	Задает текст подсказки, связанный с указанным элементом управления, а затем отображает подсказку модально в указанной относительной позиции.
Show(String, IWin32Window)	Задает текст подсказки, связанный с указанным элементом управления, и отображает модификатор подсказки.
StopTimer()	Останавливает таймер, который скрывает отображаемые подсказки.
ToString()	Возвращает строковое представление для этого элемента управления.

События

Имя	Описание
Draw	Происходит при рисовании подсказки, для свойства OwnerDraw задано true значение, а IsBalloon свойство — false.
Popup	Происходит перед отображением подсказки. Это событие по умолчанию для ToolTip класса.

См. также раздел

• ToolTipIcon
• HelpProvider
• Поставщики расширений
• Компонент подсказки (Windows Forms)