SalToolTipManager

Namespace: PPJ.Runtime.Windows.QO

Assembly: PPJ.Runtime.50 (5.0.0.0)

Manages Quick Objects tooltip registration and text for controls.

C#

public class SalToolTipManager : SalFunctionalClass

VB.NET

Public Class SalToolTipManager
    Inherits SalFunctionalClass

Example:

using PPJ.Runtime.Windows.QO;

var manager = new SalToolTipManager();

Constructors

SalToolTipManager()

Initializes a tooltip manager.

SalToolTipManager(derived)

Initializes a tooltip manager for an owning object.

Name	Type	Description
derived	Object	The owning object used for SAL multiple-inheritance delegation.

Properties

ToolTip

ToolTip: Gets the lazily created shared native tooltip control.

The instance is connected to the manager's display, text, and dismissal handlers.

Methods

AddTool(ctrl, sTip, sStatus)

Associates tooltip text and status text with a control.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.
sTip	SalString	The tooltip text.
sStatus	SalString	The status-bar text; ignored by the Web implementation.

Returns: SalBoolean. True if the control is registered; otherwise, false.

User controls also register their immediate children.

AddTool(ctrl, sTip, sStatus, bTracking)

Associates tooltip text and status text with a control.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.
sTip	SalString	The tooltip text.
sStatus	SalString	The status-bar text; ignored by the Web implementation.
bTracking	SalBoolean	Whether to enable absolute tracking; ignored by the Web implementation.

Returns: SalBoolean. True if the control is registered; otherwise, false.

User controls also register their immediate children.

AddToolEx(ctrl, sTip, sStatus, bTracking, nMessage)

Registers a tooltip with tracking and display-message settings.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.
sTip	SalString	The tooltip text.
sStatus	SalString	The status-bar text; ignored by the Web implementation.
bTracking	SalBoolean	Whether to enable absolute tracking; ignored by the Web implementation.
nMessage	SalNumber	The tooltip-display message; ignored by the Web implementation.

Returns: SalBoolean. True if the control is registered; otherwise, false.

User controls also register their immediate children.

DeleteTool(ctrl)

Unregisters a control's tooltip.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.

Returns: SalBoolean. True if the control is removed; otherwise, false.

For a user control, unregisters its immediate children as well.

GetStatusText(ctrl)

Reads a registered control's status-bar text.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.

Returns: SalString. The stored status text; an empty string if no status data exists; SalString.Null if the control is not registered.

GetTipText(ctrl)

Reads a registered control's tooltip text.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.

Returns: SalString. The tooltip text, or SalString.Null if the control is not registered.

IsTool(ctrl)

Tests whether a control has a tooltip registration.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.

Returns: SalBoolean. True if registered; otherwise, false.

SetStatusText(ctrl, sText)

Updates the status-bar text for a registered control.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.
sText	SalString	The replacement text.

Returns: SalBoolean. True if tooltip information exists; otherwise, false.

SetTipText(ctrl, sText)

Updates the tooltip text for a registered control.

Parameter	Type	Description
ctrl	Control	The control associated with the tooltip.
sText	SalString	The replacement text.

Returns: SalBoolean. True if the control is registered and updated; otherwise, false.