ToolTip Класс

Определение

Представляет небольшое прямоугольное всплывающее окно, в котором отображается краткое описание назначения элемента управления, когда пользователь наводит указатель мыши на элемент управления.Represents a small rectangular pop-up window that displays a brief description of a control's purpose when the user rests the pointer on the control.

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
Наследование
Реализации

Примеры

В следующем примере кода создается экземпляр класса ToolTip и связывается с экземпляром Form, в котором создается экземпляр.The following code example creates an instance of the ToolTip class and associates the instance with the Form that the instance is created within. Затем код инициализирует свойства задержки AutoPopDelay, InitialDelayи ReshowDelay.The code then initializes the delay properties AutoPopDelay, InitialDelay, and ReshowDelay. Кроме того, экземпляр класса ToolTip задает для свойства ShowAlways значение true, чтобы текст подсказки всегда отображался независимо от того, активна ли эта форма.In addition the instance of the ToolTip class sets the ShowAlways property to true to enable ToolTip text to always be display regardless of whether the form is active. Наконец, в примере текст подсказки связывается с двумя элементами управления в форме, Button и CheckBox.Finally, the example associates ToolTip text with two controls on a form, a Button and a CheckBox. В этом примере кода требуется, чтобы метод, определенный в примере, размещался в Form, содержащем элемент управления Button с именем button1 и CheckBox с именем checkBox1, и что метод вызывается из конструктора Form.The code example requires that the method defined in the example is located within a Form that contains a Button control named button1 and a CheckBox control named checkBox1, and that the method is called from the constructor of the 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 можно предоставить указания пользователю, когда пользователь помещает указатель мыши на элемент управления.With the ToolTip class, you can provide hints to a user when the user places the pointer on a control. Класс ToolTip обычно используется для оповещения пользователей о предполагаемом использовании элемента управления.The ToolTip class is typically used to alert users to the intended use of a control. Например, можно указать текст подсказки для элемента управления TextBox, который принимает имя, указав формат имени, вводимого в элемент управления.For example, you can specify ToolTip text for a TextBox control that accepts a name, specifying the format of the name to be typed into the control. Кроме указания, можно также использовать класс ToolTip для предоставления сведений о состоянии времени выполнения.In addition to providing hints, you can also use the ToolTip class to provide run time status information. Например, можно использовать класс ToolTip для отображения скорости подключения и данных качества линии, когда пользователь перемещает указатель на элемент управления PictureBox, отображающий состояние подключения к Интернету.For example, you can use the ToolTip class to display connection speed and line quality data when the user moves the pointer onto a PictureBox control that displays Internet connection status.

Класс ToolTip можно использовать в любом контейнере.The ToolTip class can be used in any container. Чтобы явно указать контейнер, используйте конструктор ToolTip(IContainer).To explicitly specify a container, use the ToolTip(IContainer) constructor. Для создания подсказок для нескольких элементов управления в одной форме обычно используется один ToolTip компонент.A single ToolTip component typically is used to create ToolTips for multiple controls on a single form. После создания ToolTipиспользуйте отдельный вызов метода SetToolTip, чтобы связать отображаемый текст подсказки с отдельным элементом управления.After you create a ToolTip, use a separate call to the SetToolTip method to associate ToolTip display text to an individual control. Затем, когда пользователь перемещает указатель мыши на элемент управления, отображается подсказка с текстом.Then when the user moves the pointer on a control, the ToolTip with its text is displayed. Можно вызвать SetToolTip несколько раз для одного и того же элемента управления, чтобы изменить текст, связанный с элементом управления.You can call SetToolTip more than once for the same control to change the text that is associated with the control. Чтобы получить текст, связанный с элементом управления, используйте метод GetToolTip.To get the text that is associated with a control, use the GetToolTip method. Чтобы удалить все связи текста всплывающих подсказок с экземпляром класса ToolTip, используйте метод RemoveAll.To remove all ToolTip text associations with an instance of the ToolTip class, use the RemoveAll method.

Примечание

Текст подсказки не отображается для отключенных элементов управления.ToolTip text is not displayed for controls that are disabled. Если свойство ShowAlways не имеет значение true, подсказки не отображаются, если их контейнер неактивен.Unless the ShowAlways property is set to true, ToolTips are not displayed when their container is inactive.

Класс ToolTip предоставляет следующие свойства и методы для изменения поведения по умолчанию и внешнего вида всплывающей подсказки.The ToolTip class provides the following properties and methods to modify the default behavior and appearance of a ToolTip.

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

Если вы хотите отключить весь текст подсказки, чтобы он не отображался в приложении, можно использовать свойство Active.If you want to disable all ToolTip text so that it cannot be displayed in your application, you can use the Active property. Обычно подсказка рисуется операционной системой, но для настройки внешнего вида ToolTipможно установить свойство OwnerDraw для true и обработайте событие Draw.Usually the ToolTip is drawn by the operating system, but to customize the appearance of the ToolTip, you can set the OwnerDraw property to true and handle the Draw event.

Класс ToolTipTitle реализует интерфейс System.ComponentModel.IExtenderProvider, который содержит один метод CanExtend.The ToolTipTitle class implements the System.ComponentModel.IExtenderProvider interface, which has a single method, CanExtend. Подсказки расширяют элементы управления в той же форме во время разработки, добавляя свойство ToolTip.ToolTips extend controls on the same form at design time, adding a ToolTip property. Дополнительные сведения о поставщиках расширений см. в разделе поставщики расширителей.For more information about extender providers, see Extender Providers.

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

ToolTip()

Инициализирует новый экземпляр класса ToolTip без указания контейнера.Initializes a new instance of the ToolTip without a specified container.

ToolTip(IContainer)

Инициализирует новый экземпляр класса ToolTip, используя заданный контейнер.Initializes a new instance of the ToolTip class with a specified container.

Свойства

Active

Возвращает или задает значение, указывающее, активна ли в настоящий момент всплывающая подсказка.Gets or sets a value indicating whether the ToolTip is currently active.

AutomaticDelay

Возвращает или задает автоматическую задержку всплывающей подсказки.Gets or sets the automatic delay for the ToolTip.

AutoPopDelay

Возвращает или задает интервал времени, в течение которого всплывающая подсказка отображается на экране, когда указатель мыши останавливается в границах элемента управления с текстом данной подсказки.Gets or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

BackColor

Возвращает или задает цвет фона для всплывающей подсказки.Gets or sets the background color for the ToolTip.

CanRaiseEvents

Возвращает значение, показывающее, может ли компонент вызывать событие.Gets a value indicating whether the component can raise an event.

(Унаследовано от Component)
Container

Возвращает контейнер IContainer, содержащий компонент Component.Gets the IContainer that contains the Component.

(Унаследовано от Component)
CreateParams

Возвращает параметры создания для окна всплывающей подсказки.Gets the creation parameters for the ToolTip window.

DesignMode

Возвращает значение, указывающее, находится ли данный компонент Component в режиме конструктора в настоящее время.Gets a value that indicates whether the Component is currently in design mode.

(Унаследовано от Component)
Events

Возвращает список обработчиков событий, которые прикреплены к этому объекту Component.Gets the list of event handlers that are attached to this Component.

(Унаследовано от Component)
ForeColor

Возвращает или задает цвет для всплывающей подсказки.Gets or sets the foreground color for the ToolTip.

InitialDelay

Возвращает или задает интервал времени перед появлением всплывающей подсказки.Gets or sets the time that passes before the ToolTip appears.

IsBalloon

Возвращает или задает значение, указывающее, должна ли всплывающая подсказка использовать всплывающее окно.Gets or sets a value indicating whether the ToolTip should use a balloon window.

OwnerDraw

Возвращает или задает значение, указывающее, выводится ли всплывающая подсказка операционной системой или кодом разработчика.Gets or sets a value indicating whether the ToolTip is drawn by the operating system or by code that you provide.

ReshowDelay

Возвращает или задает интервал времени, который должен пройти перед появлением окна очередной всплывающей подсказки при перемещении указателя мыши с одного элемента управления на другой.Gets or sets the length of time that must transpire before subsequent ToolTip windows appear as the pointer moves from one control to another.

ShowAlways

Возвращает или задает значение, указывающее, отображается ли окно всплывающей подсказки, если родительский элемент управления не активен.Gets or sets a value indicating whether a ToolTip window is displayed, even when its parent control is not active.

Site

Возвращает или задает ISite объекта Component.Gets or sets the ISite of the Component.

(Унаследовано от Component)
StripAmpersands

Возвращает или задает значение, определяющее способ обработки знаков амперсанда (&).Gets or sets a value that determines how ampersand (&) characters are treated.

Tag

Получает или задает объект, содержащий предоставленные программистом данные, связанные с объектом ToolTip.Gets or sets the object that contains programmer-supplied data associated with the ToolTip.

ToolTipIcon

Возвращает или задает значение, определяющее тип значка, отображаемого вместе с текстом всплывающей подсказки.Gets or sets a value that defines the type of icon to be displayed alongside the ToolTip text.

ToolTipTitle

Возвращает или задает заголовок окна всплывающей подсказки.Gets or sets a title for the ToolTip window.

UseAnimation

Возвращает или задает значение, определяющее, должен ли при отображении всплывающей подсказки использоваться эффект анимации.Gets or sets a value determining whether an animation effect should be used when displaying the ToolTip.

UseFading

Возвращает или задает значение, определяющее, должен ли при отображении всплывающей подсказки использоваться эффект затухания.Gets or sets a value determining whether a fade effect should be used when displaying the ToolTip.

Методы

CanExtend(Object)

Возвращает значение true, если всплывающая подсказка может предложить свойство средства расширения для заданного целевого компонента.Returns true if the ToolTip can offer an extender property to the specified target component.

CreateObjRef(Type)

Создает объект, который содержит всю необходимую информацию для создания прокси-сервера, используемого для взаимодействия с удаленным объектом.Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object.

(Унаследовано от MarshalByRefObject)
Dispose()

Освобождает все ресурсы, занятые модулем Component.Releases all resources used by the Component.

(Унаследовано от Component)
Dispose(Boolean)

Освобождает неуправляемые ресурсы, используемые Component, и дополнительно освобождает управляемые ресурсы.Releases the unmanaged resources used by the Component and optionally releases the managed resources.

Equals(Object)

Определяет, равен ли указанный объект текущему объекту.Determines whether the specified object is equal to the current object.

(Унаследовано от Object)
Finalize()

Освобождает неуправляемые ресурсы и выполняет другие операции очистки перед утилизацией объекта Cursor во время сборки мусора.Releases the unmanaged resources and performs other cleanup operations before the Cursor is reclaimed by the garbage collector.

GetHashCode()

Служит в качестве хэш-функции по умолчанию.Serves as the default hash function.

(Унаследовано от Object)
GetLifetimeService()

Извлекает объект обслуживания во время существования, который управляет политикой времени существования данного экземпляра.Retrieves the current lifetime service object that controls the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
GetService(Type)

Возвращает объект, представляющий службу, предоставляемую классом Component или классом Container.Returns an object that represents a service provided by the Component or by its Container.

(Унаследовано от Component)
GetToolTip(Control)

Извлекает текст всплывающей подсказки, связанный с указанным элементом управления.Retrieves the ToolTip text associated with the specified control.

GetType()

Возвращает объект Type для текущего экземпляра.Gets the Type of the current instance.

(Унаследовано от Object)
Hide(IWin32Window)

Скрывает заданное окно всплывающей подсказки.Hides the specified ToolTip window.

InitializeLifetimeService()

Получает объект службы времени существования для управления политикой времени существования для этого экземпляра.Obtains a lifetime service object to control the lifetime policy for this instance.

(Унаследовано от MarshalByRefObject)
MemberwiseClone()

Создает неполную копию текущего объекта Object.Creates a shallow copy of the current Object.

(Унаследовано от Object)
MemberwiseClone(Boolean)

Создает неполную копию текущего объекта MarshalByRefObject.Creates a shallow copy of the current MarshalByRefObject object.

(Унаследовано от MarshalByRefObject)
RemoveAll()

Удаляет весь текст всплывающей подсказки, связанной с компонентом ToolTip.Removes all ToolTip text currently associated with the ToolTip component.

SetToolTip(Control, String)

Связывает текст всплывающей подсказки с указанным элементом управления.Associates ToolTip text with the specified control.

Show(String, IWin32Window)

Задает текст всплывающей подсказки, связанный с указанным элементом управления, и отображает всплывающую подсказку в модальном режиме.Sets the ToolTip text associated with the specified control, and displays the ToolTip modally.

Show(String, IWin32Window, Int32)

Задает текст всплывающей подсказки, связанный с указанным элементом управления, а затем отображает всплывающую подсказку в течение заданного времени.Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration.

Show(String, IWin32Window, Int32, Int32)

Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в модальном режиме в заданной относительной позиции.Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Int32, Int32, Int32)

Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в течение указанного времени в заданной относительной позиции.Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.

Show(String, IWin32Window, Point)

Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в модальном режиме в заданной относительной позиции.Sets the ToolTip text associated with the specified control, and then displays the ToolTip modally at the specified relative position.

Show(String, IWin32Window, Point, Int32)

Задает текст всплывающей подсказки, связанной с указанным элементом управления, а затем отображает всплывающую подсказку в течение указанного времени в заданной относительной позиции.Sets the ToolTip text associated with the specified control, and then displays the ToolTip for the specified duration at the specified relative position.

StopTimer()

Останавливает таймер, скрывающий отображенные всплывающие подсказки.Stops the timer that hides displayed ToolTips.

ToString()

Возвращает строковое представление для этого элемента управления.Returns a string representation for this control.

События

Disposed

Происходит при удалении компонента вызовом метода Dispose().Occurs when the component is disposed by a call to the Dispose() method.

(Унаследовано от Component)
Draw

Происходит при отображении всплывающей подсказки, если для свойства OwnerDraw установлено значение true, а для свойства IsBalloon — значение false.Occurs when the ToolTip is drawn and the OwnerDraw property is set to true and the IsBalloon property is false.

Popup

Происходит перед первоначальным отображением всплывающей подсказки.Occurs before a ToolTip is initially displayed. Это событие по умолчанию для класса ToolTip.This is the default event for the ToolTip class.

Применяется к

Дополнительно