# ToolTip Namespace: **Wisej.Web** Assembly: **Wisej.Framework** (3.1.0.0) * [Component](https://docs.wisej.com/api/v3.1/wisej.base/general/wisej.base.component) * [Component](https://docs.wisej.com/api/v3.1/wisej.web/general/wisej.web.component) * [ToolTip](https://docs.wisej.com/api/v3.1/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. {% tabs %} {% tab title="C#" %} ```csharp public class ToolTip : Component, IExtenderProvider ``` {% endtab %} {% tab title="VB.NET" %} ```visual-basic Public Class ToolTip Inherits Component Implements IExtenderProvider ``` {% endtab %} {% endtabs %} ## Constructors ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ToolTip() Initializes a new instance of the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip) without a specified container. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ToolTip(container) Initializes a new instance of the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip) class with a specified container. | Name | Type | Description | | ------------- | ------------------------------------------------------------------------------------------ | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **container** | [IContainer](https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.icontainer) | An [IContainer](https://docs.microsoft.com/en-us/dotnet/api/system.componentmodel.icontainer) that represents the container of the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip) extender. | ## Properties ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Active [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean): Returns or sets whether the ToolTip provider is currently active. (Default: `True`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Alignment [Nullable\](https://docs.microsoft.com/en-us/dotnet/api/system.nullable): Returns or sets the alignment side and position of the tooltips. (Default: `null`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)AllowHtml [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean): Returns or sets a value indicating that the control can display HTML in the Text property. (Default: `False`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)AutomaticDelay [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32): Returns or sets the automatic delay for the ToolTip. (Default: `500`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)AutoPopDelay [Int32](https://docs.microsoft.com/en-us/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. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ForeColor [Color](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.color): Returns or sets the text color of the ToolTip. (Default: `Color [Empty]`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)InitialDelay [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32): Returns or sets the time that passes before the ToolTip appears. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Tag [Object](https://docs.microsoft.com/en-us/dotnet/api/system.object): Returns or sets the object that contains programmer-supplied data associated with the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip). (Default: `null`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ToolTipIcon [ToolTipIcon](https://docs.wisej.com/api/v3.1/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`) ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)ToolTipIconSource [String](https://docs.microsoft.com/en-us/dotnet/api/system.string): Returns or sets the icon name or URL to use as the ToolTip icon. (Default: `null`) ## Methods ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)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/en-us/dotnet/api/system.object) | The target object to add an extender property to. | **Returns:** [Boolean](https://docs.microsoft.com/en-us/dotnet/api/system.boolean). true if the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip) class can offer one or more extender properties; otherwise, false. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Clear() Removes all ToolTip text currently associated with the ToolTip component. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)GetToolTip(control) Retrieves the ToolTip text associated with the specified control. | Parameter | Type | Description | | ----------- | -------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | **control** | [Control](https://docs.wisej.com/api/v3.1/wisej.web/general/control) | The [Control](https://docs.wisej.com/api/v3.1/wisej.web/general/control) for which to retrieve the [ToolTip](https://docs.wisej.com/api/v3.1/wisej.web/extenders/wisej.web.tooltip) text. | **Returns:** [String](https://docs.microsoft.com/en-us/dotnet/api/system.string). A [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) containing the ToolTip text for the specified control. ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)SetToolTip(control, caption) Associates ToolTip text with the specified control. | Parameter | Type | Description | | ----------- | -------------------------------------------------------------------- | ------------------------------------------------------------------------------------------------------------ | | **control** | [Control](https://docs.wisej.com/api/v3.1/wisej.web/general/control) | The [Control](https://docs.wisej.com/api/v3.1/wisej.web/general/control) to associate the ToolTip text with. | | **caption** | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) | The ToolTip text to display when the pointer is on the control. | ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Show(target, text) Shows the tooltip net to the *target* component. | Parameter | Type | Description | | ---------- | --------------------------------------------------------------------------------------------------- | --------------------------------------------------- | | **target** | [IWisejComponent](https://docs.wisej.com/api/v3.1/wisej.core/interfaces/wisej.core.iwisejcomponent) | A Wisej control or component (i.e. column, header). | | **text** | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) | Text to show in the tooltip. | ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Show(text, x, y) Shows the tooltip at the specified *x* and *y* screen coordinates. | Parameter | Type | Description | | --------- | ------------------------------------------------------------------- | ---------------------------- | | **text** | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) | Text to show in the tooltip. | | **x** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) | | | **y** | [Int32](https://docs.microsoft.com/en-us/dotnet/api/system.int32) | | ### ![](https://3858804530-files.gitbook.io/~/files/v0/b/gitbook-x-prod.appspot.com/o/spaces%2F1zeuyneJ2f5i3NKcg6us%2Fuploads%2Fgit-blob-2389c55cd19719a73a5ae98e1528c8dc8525cc35%2Finstance.png?alt=media)Show(text, location) Shows the tooltip at the specified *location* . | Parameter | Type | Description | | ------------ | ------------------------------------------------------------------------- | ---------------------------------------------- | | **text** | [String](https://docs.microsoft.com/en-us/dotnet/api/system.string) | Text to show in the tooltip. | | **location** | [Point](https://docs.microsoft.com/en-us/dotnet/api/system.drawing.point) | Location of the tooltip in screen coordinates. | ## Implements | Name | Description | | --------------------------------------------------------------------------------------------------------- | ---------------------------------------------- | | [IWisejComponent](https://docs.wisej.com/api/v3.1/wisej.core/interfaces/wisej.core.iwisejcomponent) | All wisej components implement this interface. | | [IWisejSerializable](https://docs.wisej.com/api/v3.1/wisej.core/interfaces/wisej.core.iwisejserializable) | Allows an object to serialize itself. |