Wisej.NET API
Home
Support
Documentation
Search…
v3.0
Welcome
What's New
Releases
Concepts
Themes
Extensions
Wisej.Web
General
Buttons
Common Dialogs
Containers
Content
Data Binding
Editors
Enumerations
Extenders
Animation
ErrorAnimationType
ErrorBlinkStyle
ErrorIconAlignment
ErrorProvider
HelpTip
JavaScript
Rotation
StyleSheet
TabOrderManager
ToolTip
ToolTipIcon
Interfaces
Lists & Grids
Media
Menus
Notifications
Other Components
Wisej.Web.VisualBasic
Extensions
Wisej.Core
General
Interfaces
Wisej.Base
General
Responsive
System
Extensions
Powered By
GitBook
ToolTip
Wisej.Web.ToolTip
Namespace:
Wisej.Web
Assembly:
Wisej.Framework
(3.0.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#
VB.NET
1
public
class
ToolTip
:
Component
,
IExtenderProvider
Copied!
1
Public
Class
ToolTip
2
Inherits
Component
3
Implements
IExtenderProvider
Copied!
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.
​
Alignment
​
Nullable<Placement>
: Returns or sets the alignment side and position of the tooltips.
​
AllowHtml
​
Boolean
: Returns or sets a value indicating that the control can display HTML in the Text property.
​
AutomaticDelay
​
Int32
: Returns or sets the automatic delay for the ToolTip.
​
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.
​
ForeColor
​
Color
: Returns or sets the text color of the ToolTip.
​
InitialDelay
​
Int32
: Returns or sets the time that passes before the ToolTip appears.
​
Tag
​
Object
: Returns or sets the object that contains programmer-supplied data associated with the
ToolTip
.
​
ToolTipIcon
​
ToolTipIcon
: Returns or sets a value that defines the type of icon to be displayed alongside the ToolTip text.
​
ToolTipIconSource
​
String
: Returns or sets the icon name or URL to use as the ToolTip icon.
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.
​
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.
​
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.
Inherited
Methods
Name
Description
From
​
Update()
​
Updates the component on the client.
​
Component
​
Implements
Name
Description
​
IWisejComponent
​
All wisej components implement this interface.
​
IWisejSerializable
​
Allows an object to serialize itself.
Previous
TabOrderManager
Next
ToolTipIcon
Last modified
2mo ago
Export as PDF
Copy link
Contents
Constructors
ToolTip()
ToolTip(container)
Properties
Active
Alignment
AllowHtml
AutomaticDelay
AutoPopDelay
ForeColor
InitialDelay
Tag
ToolTipIcon
ToolTipIconSource
Methods
CanExtend(target)
Clear()
GetToolTip(control)
SetToolTip(control, caption)
Show(target, text)
Show(text, x, y)
Show(text, location)
Inherited
Methods
Implements