ToolTipController Members

Provides tooltip management for individual controls.

Constructors

Name Description
ToolTipController() Creates a new instance of the ToolTipController class.
ToolTipController(IContainer) Initializes a new instance of the ToolTipController class with the specified container.

Properties

Name Description
Active Gets or sets whether the component's functionality is enabled.
ActiveControlClient Gets the active control, if it implements the IToolTipControlClient interface.
ActiveObject Returns the object that identifies which of the bound control's elements the tooltip is displayed for.
ActiveObjectInfo An object containing tooltip information for the current element of a bound control.
AllowHtmlText Gets or sets whether HTML formatting tags can be used to format text in tooltips.
Appearance Gets or sets the settings that control the appearance of a tooltip's window and text.
AppearanceTitle Provide the settings that control the appearance of a tooltip's title.
AutoPopDelay Gets or sets the timeframe during which a tooltip is visible on-screen.
CanRaiseEvents protected Gets a value indicating whether the component can raise an event. Inherited from Component.
CloseOnClick Gets or sets whether a tooltip is closed on a click.
Container Gets the IContainer that contains the Component. Inherited from Component.
DefaultController static Gets the default ToolTipController used for displaying tooltips.
DesignMode protected Gets a value that indicates whether the Component is currently in design mode. Inherited from Component.
Events protected Gets the list of event handlers that are attached to this Component. Inherited from Component.
IconSize Gets or sets the tooltip icon size.
IconType Obsolete. Gets or sets the tooltip icon type. This property is obsolete, use ToolTipIconType instead.
ImageIndex Gets or sets the index of an image to be displayed within tooltips.
ImageList Gets or sets the source of the images that can be displayed within tooltips.
InitialDelay Gets or sets the time interval between a visual element being hovered, and its tooltip being shown on-screen.
IsDefaultToolTipLocation This member supports the internal infrastructure, and is not intended to be used directly from your code.
KeepWhileHovered Gets or sets whether a displayed tooltip remains visible while the mouse cursor keeps moving (without pauses) towards the tooltip and while it hovers the tooltip.
ReshowDelay Gets or sets the time interval that must pass before another hint is displayed if another hint is currently visible.
Rounded Gets or sets whether the tooltip's corners are rounded.
RoundRadius Gets or sets the radius of the rounded corners of the tooltip window.
ShowBeak Tests whether callout beaks are displayed for hints.
ShowShadow Gets or sets whether the tooltips are shown shadowed.
Site Gets or sets the ISite of the Component. Inherited from Component.
Style Gets the appearance settings used to paint the hints of bound controls.
ToolTipAnchor Gets or sets whether tooltips are anchored relative to the mouse pointer or relative to the owning control. This property is not in effect if you handle the ToolTipController.GetActiveObjectInfo event.
ToolTipLocation Gets or sets the tooltip location.
ToolTipStyle Gets or sets the look-and-feel of regular tooltips.
ToolTipType Gets or sets the type of tooltips displayed by the controller.
UseWindowStyle Obsolete. Gets or sets whether the default style should be used for the hint.

Methods

Name Description
AddClientControl(Control) Enables the display of tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface.
AddClientControl(Control, IToolTipControlClient) Enables the display of tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface.
CreateObjRef(Type) Creates an object that contains all the relevant information required to generate a proxy used to communicate with a remote object. Inherited from MarshalByRefObject.
CreateShowArgs() Returns a ToolTipControllerShowEventArgs object containing settings of the current tooltip controller.
Dispose() Releases all resources used by the Component. Inherited from Component.
Equals(Object) Determines whether the specified object is equal to the current object. Inherited from Object.
Equals(Object, Object) static Determines whether the specified object instances are considered equal. Inherited from Object.
GetAllowHtmlText(Control) Returns whether HTML formatting is enabled in tooltips for the specified control.
GetHashCode() Serves as the default hash function. Inherited from Object.
GetLifetimeService() Retrieves the current lifetime service object that controls the lifetime policy for this instance. Inherited from MarshalByRefObject.
GetService(Type) protected Returns an object that represents a service provided by the Component or by its Container. Inherited from Component.
GetSuperTip(Control) Gets a SuperToolTip object associated with the specified control.
GetTitle(Control) Gets a regular tooltip's title displayed within the specified control.
GetToolTip(Control) Gets a regular tooltip for the specified control.
GetToolTipAnchor(Control) Gets whether the tooltip associated with the specified control is anchored relative to the mouse pointer or the owning control.
GetToolTipIconType(Control) Gets the type of the icon displayed within the specified control's regular tooltip.
GetType() Gets the Type of the current instance. Inherited from Object.
HideHint() Hides the hint if it is being displayed.
HideHintCore() This member supports the internal infrastructure, and is not intended to be used directly from your code.
InitializeLifetimeService() Obtains a lifetime service object to control the lifetime policy for this instance. Inherited from MarshalByRefObject.
MemberwiseClone() protected Creates a shallow copy of the current Object. Inherited from Object.
MemberwiseClone(Boolean) protected Creates a shallow copy of the current MarshalByRefObject object. Inherited from MarshalByRefObject.
ProcessNCMouseMove(Object, Point) This member supports the internal infrastructure, and is not intended to be used directly from your code.
ReferenceEquals(Object, Object) static Determines whether the specified Object instances are the same instance. Inherited from Object.
RemoveClientControl(Control) Disables displaying tooltips for the specified control implementing the DevExpress.Utils.IToolTipControlClient interface.
ResetAutoPopupDelay() Resets the timer which controls when a tooltip's window is hidden.
SetAllowHtmlText(Control, DefaultBoolean) Sets whether HTML formatting is enabled in tooltips for the specified control.
SetSuperTip(Control, SuperToolTip) Associates a SuperToolTip object with the specified control.
SetTitle(Control, String) Sets a regular tooltip's title for the specified control.
SetToolTip(Control, String) Sets a regular tooltip for the specified control.
SetToolTipAnchor(Control, ToolTipAnchor) Sets whether the tooltip associated with the specified control is anchored relative to the mouse pointer or the owning control.
SetToolTipIconType(Control, ToolTipIconType) Sets the type of the icon displayed within the specified control's regular tooltip.
ShowHint(ToolTipControlInfo) Displays a hint using the specified tooltip information.
ShowHint(ToolTipControllerShowEventArgs) Displays a hint relative to the mouse cursor using specified settings.
ShowHint(ToolTipControllerShowEventArgs, Point) Displays a hint relative to a specific point using specified settings.
ShowHint(ToolTipControllerShowEventArgs, Control) Displays a hint for a control using specified settings.
ShowHint(String) Displays a hint relative to the mouse cursor using current ToolTipController settings.
ShowHint(String, ToolTipLocation) Displays a hint at the specified position relative to the mouse cursor.
ShowHint(String, ToolTipLocation, Point) Displays a hint at a specified position relative to a specific point.
ShowHint(String, Point) Displays a hint relative to the specified point using current ToolTipController settings
ShowHint(String, String) Displays a hint with the specified text and title relative to the mouse cursor using the current ToolTipController settings.
ShowHint(String, String, ToolTipLocation) Displays a hint with the specified text and title relative to the mouse cursor's position.
ShowHint(String, String, ToolTipLocation, Point) Displays a hint with the specified text and title relative to the specified point.
ShowHint(String, String, Point) Displays a hint with the specified text and title at the specified point using the current ToolTipController settings
ShowHint(String, String, Control, ToolTipLocation) Displays a hint with the specified text and title relative to the specified control.
ShowHint(String, Control, ToolTipLocation) Displays a hint relative to a specific control.
ToString() Returns a String containing the name of the Component, if any. This method should not be overridden. Inherited from Component.

Events

Name Description
BeforeShow Fires when a tooltip is about to be displayed. Allows you to dynamically specify the tooltip text, image, and appearance settings.
CalcSize Enables you to specify the position and size of the tooltip window.
CustomDraw Enables a tooltip's window to be custom painted.
Disposed Occurs when the component is disposed by a call to the Dispose() method. Inherited from Component.
GetActiveObjectInfo Allows you to provide custom tooltips for any element of a control that implements the DevExpress.Utils.IToolTipControlClient interface.
HyperlinkClick Occurs when a user clicks a hyperlink within a control's tooltip or super tooltip.
See Also