ToolTip Класс

Определение

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

System.Windows.Forms

Сборка:

System.Windows.Forms.dll

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

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задержки , InitialDelayи ReshowDelay. Кроме того, экземпляр класса задает свойству ToolTipShowAlways значение , true чтобы разрешить всегда отображать текст подсказки независимо от того, активна ли форма. Наконец, в примере текст подсказки связывается с двумя элементами управления в форме: Button и CheckBox. В примере кода требуется, чтобы метод, определенный в примере, находился в Form объекте , который содержит Button элемент управления с именем button1 и CheckBox элемент управления с именем checkBox1, а метод вызывается из конструктора 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

Комментарии

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

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

Примечание

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

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

Категория	Связанные члены
Отображение вручную	Active, Show, Hide, ShowAlways, Popup, StopTimer
Время подсказки	AutoPopDelay, InitialDelay, ReshowDelay, AutomaticDelay, StopTimer
Content	SetToolTip, GetToolTip, StripAmpersands, ToolTipIcon, ToolTipTitle, RemoveAll
Внешний вид	BackColor, ForeColor, IsBalloon, OwnerDraw, UseAnimation, UseFading

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

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

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

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

Свойства

Active	Возвращает или задает значение, указывающее, активна ли в настоящий момент всплывающая подсказка.
AutomaticDelay	Возвращает или задает автоматическую задержку всплывающей подсказки.
AutoPopDelay	Возвращает или задает интервал времени, в течение которого всплывающая подсказка отображается на экране, когда указатель мыши останавливается в границах элемента управления с текстом данной подсказки.
BackColor	Возвращает или задает цвет фона для всплывающей подсказки.
CanRaiseEvents	Возвращает значение, показывающее, может ли компонент вызывать событие. (Унаследовано от Component)
Container	Возвращает объект IContainer, который содержит коллекцию Component. (Унаследовано от Component)
CreateParams	Возвращает параметры создания для окна всплывающей подсказки.
DesignMode	Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время. (Унаследовано от Component)
Events	Возвращает список обработчиков событий, которые прикреплены к этому объекту Component. (Унаследовано от Component)
ForeColor	Возвращает или задает цвет для всплывающей подсказки.
InitialDelay	Возвращает или задает интервал времени перед появлением всплывающей подсказки.
IsBalloon	Возвращает или задает значение, указывающее, должна ли всплывающая подсказка использовать всплывающее окно.
OwnerDraw	Возвращает или задает значение, указывающее, выводится ли всплывающая подсказка операционной системой или кодом разработчика.
ReshowDelay	Возвращает или задает интервал времени, который должен пройти перед появлением окна очередной всплывающей подсказки при перемещении указателя мыши с одного элемента управления на другой.
ShowAlways	Возвращает или задает значение, указывающее, отображается ли окно всплывающей подсказки, если родительский элемент управления не активен.
Site	Получает или задает ISite объекта Component. (Унаследовано от Component)
StripAmpersands	Возвращает или задает значение, определяющее способ обработки знаков амперсанда (&).
Tag	Получает или задает объект, содержащий предоставленные программистом данные, связанные с объектом ToolTip.
ToolTipIcon	Возвращает или задает значение, определяющее тип значка, отображаемого вместе с текстом всплывающей подсказки.
ToolTipTitle	Возвращает или задает заголовок окна всплывающей подсказки.
UseAnimation	Возвращает или задает значение, определяющее, должен ли при отображении всплывающей подсказки использоваться эффект анимации.
UseFading	Возвращает или задает значение, определяющее, должен ли при отображении всплывающей подсказки использоваться эффект затухания.

Методы

CanExtend(Object)	Возвращает значение true, если всплывающая подсказка может предложить свойство средства расширения для заданного целевого компонента.
CreateObjRef(Type)	Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом. (Унаследовано от MarshalByRefObject)
Dispose()	Освобождает все ресурсы, занятые модулем Component. (Унаследовано от Component)
Dispose(Boolean)	Освобождает неуправляемые ресурсы, используемые объектом Component, а при необходимости освобождает также управляемые ресурсы.
Equals(Object)	Определяет, равен ли указанный объект текущему объекту. (Унаследовано от Object)
Finalize()	Освобождает неуправляемые ресурсы и выполняет другие операции очистки перед утилизацией объекта Cursor во время сборки мусора.
GetHashCode()	Служит хэш-функцией по умолчанию. (Унаследовано от Object)
GetLifetimeService()	Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра. (Унаследовано от MarshalByRefObject)
GetService(Type)	Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container. (Унаследовано от Component)
GetToolTip(Control)	Извлекает текст всплывающей подсказки, связанный с указанным элементом управления.
GetType()	Возвращает объект Type для текущего экземпляра. (Унаследовано от Object)
Hide(IWin32Window)	Скрывает заданное окно всплывающей подсказки.
InitializeLifetimeService()	Получает объект службы времени существования для управления политикой времени существования для этого экземпляра. (Унаследовано от MarshalByRefObject)
MemberwiseClone()	Создает неполную копию текущего объекта Object. (Унаследовано от Object)
MemberwiseClone(Boolean)	Создает неполную копию текущего объекта MarshalByRefObject. (Унаследовано от MarshalByRefObject)
RemoveAll()	Удаляет весь текст всплывающей подсказки, связанной с компонентом ToolTip.
SetToolTip(Control, String)	Связывает текст всплывающей подсказки с указанным элементом управления.
Show(String, IWin32Window)	Задает текст всплывающей подсказки, связанный с указанным элементом управления, и отображает всплывающую подсказку в модальном режиме.
Show(String, IWin32Window, Int32)	Задает текст всплывающей подсказки, связанный с указанным элементом управления, а затем отображает всплывающую подсказку в течение заданного времени.
Show(String, IWin32Window, Int32, Int32)	Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в модальном режиме в заданной относительной позиции.
Show(String, IWin32Window, Int32, Int32, Int32)	Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в течение указанного времени в заданной относительной позиции.
Show(String, IWin32Window, Point)	Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в модальном режиме в заданной относительной позиции.
Show(String, IWin32Window, Point, Int32)	Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в течение указанного времени в заданной относительной позиции.
StopTimer()	Останавливает таймер, скрывающий отображенные всплывающие подсказки.
ToString()	Возвращает строковое представление для этого элемента управления.

События

Disposed	Возникает при удалении компонента путем вызова метода Dispose(). (Унаследовано от Component)
Draw	Происходит при отображении всплывающей подсказки, если для свойства OwnerDraw установлено значение true, а для свойства IsBalloon — значение false.
Popup	Происходит перед первоначальным отображением всплывающей подсказки. Это событие по умолчанию для класса ToolTip.

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

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