Component | +--ToolTippublic final class ToolTip
Provides tooltips for other controls.
Constructors
| Name | Description |
|---|---|
| ToolTip() | Creates a ToolTip object. |
| getToolTip(Control control) | Retrieves the current tooltip for the specified control. |
| setToolTip(Control control, String caption) | Sets the tooltip for the specified control. |
Methods
| Name | Description |
|---|---|
| addRegion(ToolTipRegion region) | Adds a tooltip region to the control. |
| getAutomaticDelay() | Retrieves the current value of the AutomaticDelay property. |
| getAutoPopDelay() | Retrieves the current value of the AutoPopDelay property. |
| getInitialDelay() | Retrieves the current value of the InitialDelay property. |
| getRegion(Control boundControl) | Retrieves the region that is bound to the specified control. |
| getRegions() | Retrieves an array of all regions. |
| getReshowDelay() | Retrieves the current value of the ReshowDelay property. |
| getShowAlways() | Retrieves the current ShowAlways value. |
| removeAllRegions() | Removes all tooltip regions from the control. |
| removeRegion(ToolTipRegion region) | Removes a single tooltip region from the control. |
| setAutomaticDelay(int value) | Sets the AutomaticDelay property. |
| setAutoPopDelay(int value) | Sets the AutoPopDelay property. |
| setInitialDelay(int value) | Sets the InitialDelay property. |
| setRegions(ToolTipRegion[] regions) | Sets the regions to display. |
| setReshowDelay(int value) | Sets the ReshowDelay property. |
| setShowAlways(boolean value) | Sets the value of ShowAlways. |
Creates a ToolTip object.
Returns the tooltip for the specified control.
Retrieves the current tooltip for the specified control.
Sets the tooltip for the specified control.
Adds a tooltip region to the control.
Returns current value of the AutomaticDelay property.
Retrieves the current value of the AutomaticDelay property.
Returns current value of the AutoPopDelay property.
Retrieves the current value of the AutoPopDelay property.
Returns current value of the InitialDelay property.
Retrieves the current value of the InitialDelay property.
Returns the region that is bound to boundControl.
Retrieves the region that is bound to the specified control.
Returns an array of all regions.
Retrieves an array of all regions.
Returns the current value of the ReshowDelay property.
Retrieves the current value of the ReshowDelay property.
Returns current ShowAlways value.
Retrieves the current ShowAlways value.
Removes all tooltip regions from the control.
Removes a single tooltip region from the control.
Sets the AutomaticDelay property. When the AutomaticDelay property is set, values are given to the AutoPopDelay, InitialDelay, and ReshowDelay based on the AutomaticDelay value. The AutoPopDelay is always set to 10 times the AutomaticDelay; the InitialDelay is set to 1/5 times the AutomaticDelay; and ReshowDelay is set to the same time as the AutomaticDelay.
Sets the AutoPopDelay property. This is the length of time the tooltip window remains visible if the pointer is stationary inside a tooltip region.
Sets the InitialDelay property. This is the length of time the pointer must remain stationary within a tooltip region before the tooltip window appears.
Sets the regions to display.
Sets the ReshowDelay property. This is the length of time it takes for subsequent tooltip windows to appear as the pointer moves from one tooltip region to another.
Sets the value of ShowAlways. When ShowAlways is set to true, the tooltips are always displayed, even if the parent form is not active.