ToolTip

Namespace: Wisej.Web

Assembly: Wisej.Framework (4.1.0.0)

• Component
  • Component
    • 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#

public class ToolTip : Component, IExtenderProvider

VB.NET

Public Class ToolTip
    Inherits Component
    Implements IExtenderProvider

Constructors

ToolTip()

Initializes a new instance of the ToolTip without a specified container.

ToolTip(container)

Initializes a new instance of the ToolTip class with a specified container.

Name	Type	Description
container	IContainer	An IContainer that represents the container of the ToolTip extender.

Properties

Active

Boolean: Returns or sets whether the ToolTip provider is currently active. (Default: True)

Alignment

Nullable<Placement>: Returns or sets the alignment side and position of the tooltips. (Default: null)

AllowHtml

Boolean: Returns or sets a value indicating that the control can display HTML in the Text property. (Default: False)

AutomaticDelay

Int32: Returns or sets the automatic delay for the ToolTip. (Default: 500)

AutoPopDelay

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.

ForeColor

Color: Returns or sets the text color of the ToolTip. (Default: Color [Empty])

InitialDelay

Int32: Returns or sets the time that passes before the ToolTip appears.

The default value is 500.

Tag

Object: Returns or sets the object that contains programmer-supplied data associated with the ToolTip. (Default: null)

ToolTipIcon

ToolTipIcon: Returns or sets a value that defines the type of icon to be displayed alongside the ToolTip text. (Default: Default)

ToolTipIconSource

String: Returns or sets the icon name or URL to use as the ToolTip icon. (Default: null)

Methods

CanExtend(target)

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

Parameter	Type	Description
target	Object	The target object to add an extender property to.

Returns: Boolean. true if the ToolTip class can offer one or more extender properties; otherwise, false.

Clear()

Removes all ToolTip text currently associated with the ToolTip component.

Dispose(disposing)

Parameter	Type	Description
disposing	Boolean

GetToolTip(control)

Retrieves the ToolTip text associated with the specified control.

Parameter	Type	Description
control	Control	The Control for which to retrieve the ToolTip text.

Returns: String. A String containing the ToolTip text for the specified control.

OnWebRender(config)

Renders the client component.

Parameter	Type	Description
config	Object	Dynamic configuration object.

SetToolTip(control, caption)

Associates ToolTip text with the specified control.

Parameter	Type	Description
control	Control	The Control to associate the ToolTip text with.
caption	String	The ToolTip text to display when the pointer is on the control.

Show(target, text)

Shows the tooltip net to the target component.

Parameter	Type	Description
target	IWisejComponent	A Wisej control or component (i.e. column, header).
text	String	Text to show in the tooltip.

Show(text, x, y)

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

Parameter	Type	Description
text	String	Text to show in the tooltip.
x	Int32
y	Int32

Show(text, location)

Shows the tooltip at the specified location .

Parameter	Type	Description
text	String	Text to show in the tooltip.
location	Point	Location of the tooltip in screen coordinates.

Implements

Name	Description
IUserData	Provides access to the UserData and Tag properties associated to the component implementing this interface.
IWisejComponent	All wisej components implement this interface.
IWisejSerializable	Allows an object to serialize itself.