# ToolTip

URL: https://docs.wisej.com/api/wisej.web/extenders/wisej.web.tooltip

Version: 4.1
Namespace: **Wisej.Web**

Assembly: **Wisej.Framework** (4.1.0.0)

- [Component](/api/wisej.base/general/wisej.base.component)
- [Component](/api/wisej.web/general/wisej.web.component)
- [ToolTip](/api/wisej.web/extenders/wisej.web.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.

- C# - VB.NET

```csharp
public class ToolTip : Component, IExtenderProvider
```

```visual
Public Class ToolTip
    Inherits Component
    Implements IExtenderProvider
```

## Constructors

### ![Instance member](/img/api/instance.png) ToolTip()

Initializes a new instance of the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) without a specified container.

### ![Instance member](/img/api/instance.png) ToolTip(container)

Initializes a new instance of the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) class with a specified container.

| Name | Type | Description | **container** | [IContainer](https://docs.microsoft.com/dotnet/api/system.componentmodel.icontainer) | An [IContainer](https://docs.microsoft.com/dotnet/api/system.componentmodel.icontainer) that represents the container of the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) extender. 

## Properties

### ![Instance member](/img/api/instance.png) Active

[Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) : Returns or sets whether the ToolTip provider is currently active. (Default: `True` )

### ![Instance member](/img/api/instance.png) Alignment

[Nullable<Placement>](https://docs.microsoft.com/dotnet/api/system.nullable-1) : Returns or sets the alignment side and position of the tooltips. (Default: `null` )

### ![Instance member](/img/api/instance.png) AllowHtml

[Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) : Returns or sets a value indicating that the control can display HTML in the Text property. (Default: `False` )

### ![Instance member](/img/api/instance.png) AutomaticDelay

[Int32](https://docs.microsoft.com/dotnet/api/system.int32) : Returns or sets the automatic delay for the ToolTip. (Default: `500` )

### ![Instance member](/img/api/instance.png) AutoPopDelay

[Int32](https://docs.microsoft.com/dotnet/api/system.int32) : Returns or sets the period of time the ToolTip remains visible if the pointer is stationary on a control with specified ToolTip text.

The default value is 5000.

### ![Instance member](/img/api/instance.png) ForeColor

[Color](https://docs.microsoft.com/dotnet/api/system.drawing.color) : Returns or sets the text color of the ToolTip. (Default: `Color [Empty]` )

### ![Instance member](/img/api/instance.png) InitialDelay

[Int32](https://docs.microsoft.com/dotnet/api/system.int32) : Returns or sets the time that passes before the ToolTip appears.

The default value is 500.

### ![Instance member](/img/api/instance.png) Tag

[Object](https://docs.microsoft.com/dotnet/api/system.object) : Returns or sets the object that contains programmer-supplied data associated with the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) . (Default: `null` )

### ![Instance member](/img/api/instance.png) ToolTipIcon

[ToolTipIcon](/api/wisej.web/extenders/wisej.web.tooltipicon) : Returns or sets a value that defines the type of icon to be displayed alongside the ToolTip text. (Default: `Default` )

### ![Instance member](/img/api/instance.png) ToolTipIconSource

[String](https://docs.microsoft.com/dotnet/api/system.string) : Returns or sets the icon name or URL to use as the ToolTip icon. (Default: `null` )

## Methods

### ![Instance member](/img/api/instance.png) CanExtend(target)

Returns true if the ToolTip can offer an extender property to the specified target component.

| Parameter | Type | Description | **target** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | The target object to add an extender property to. 

**Returns:**[Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) . true if the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) class can offer one or more extender properties; otherwise, false.

### ![Instance member](/img/api/instance.png) Clear()

Removes all ToolTip text currently associated with the ToolTip component.

### ![Protected member](/img/api/protected.png) Dispose(disposing)

| Parameter | Type | Description | **disposing** | [Boolean](https://docs.microsoft.com/dotnet/api/system.boolean) | 

### ![Instance member](/img/api/instance.png) GetToolTip(control)

Retrieves the ToolTip text associated with the specified control.

| Parameter | Type | Description | **control** | Control | TheControl for which to retrieve the [ToolTip](/api/wisej.web/extenders/wisej.web.tooltip) text. 

**Returns:**[String](https://docs.microsoft.com/dotnet/api/system.string) . A [String](https://docs.microsoft.com/dotnet/api/system.string) containing the ToolTip text for the specified control.

### ![Protected member](/img/api/protected.png) OnWebRender(config)

Renders the client component.

| Parameter | Type | Description | **config** | [Object](https://docs.microsoft.com/dotnet/api/system.object) | Dynamic configuration object. 

### ![Instance member](/img/api/instance.png) SetToolTip(control, caption)

Associates ToolTip text with the specified control.

| Parameter | Type | Description | **control** | Control | TheControl to associate the ToolTip text with. | **caption** | [String](https://docs.microsoft.com/dotnet/api/system.string) | The ToolTip text to display when the pointer is on the control. 

### ![Instance member](/img/api/instance.png) Show(target, text)

Shows the tooltip net to the *target* component.

| Parameter | Type | Description | **target** | [IWisejComponent](/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | A Wisej control or component (i.e. column, header). | **text** | [String](https://docs.microsoft.com/dotnet/api/system.string) | Text to show in the tooltip. 

### ![Instance member](/img/api/instance.png) Show(text, x, y)

Shows the tooltip at the specified *x* and *y* screen coordinates.

| Parameter | Type | Description | **text** | [String](https://docs.microsoft.com/dotnet/api/system.string) | Text to show in the tooltip. | **x** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | | **y** | [Int32](https://docs.microsoft.com/dotnet/api/system.int32) | 

### ![Instance member](/img/api/instance.png) Show(text, location)

Shows the tooltip at the specified *location* .

| Parameter | Type | Description | **text** | [String](https://docs.microsoft.com/dotnet/api/system.string) | Text to show in the tooltip. | **location** | [Point](https://docs.microsoft.com/dotnet/api/system.drawing.point) | Location of the tooltip in screen coordinates. 

## Implements

| Name | Description | [IUserData](/api/wisej.web/interfaces/wisej.web.iuserdata) | Provides access to the `UserData` and `Tag` properties associated to the component implementing this interface. | [IWisejComponent](/api/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | [IWisejSerializable](/api/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself.