SalQuickToolTipMultilineField

Namespace: PPJ.Runtime.Windows.QO

Assembly: PPJ.Runtime.50 (5.0.0.0)

Provides a SAL multiline input with Quick Objects tooltip and status-text compatibility methods.

C#

public class SalQuickToolTipMultilineField : SalMultilineField

VB.NET

Public Class SalQuickToolTipMultilineField
    Inherits SalMultilineField

Tooltip behavior follows SalToolTipManager on the current platform.

Example:

using PPJ.Runtime.Windows.QO;

var control = new SalQuickToolTipMultilineField();
// Associate a tip after the control is created.
control.SetTipText("Enter or choose a value.");

Constructors

SalQuickToolTipMultilineField()

Initializes the control and its tooltip delegate.

Properties

TooltipStatus

String: Gets or sets the cached status-bar text for this control. (Default: "")

Null assignments become an empty string. Web tooltip management does not display this status text.

TooltipText

String: Gets or sets the cached tooltip text for this control. (Default: "")

Null assignments become an empty string. Setting the property forwards the text to the tooltip manager.

Methods

AddTool(hWnd, sTip, sStatus)

Associates tooltip text and status text with a control.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle 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.

DeleteTool(hWnd)

Unregisters a control's tooltip.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle associated with the tooltip.

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

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

DeleteTool()

Unregisters this control's tooltip.

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

For a user control, unregisters its immediate children as well. This overload targets the current control.

GetStatusText(hWnd)

Reads a registered control's status-bar text.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle 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.

GetStatusText()

Reads this registered control's status-bar text.

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

This overload targets the current control.

GetTipText(hWnd)

Reads a registered control's tooltip text.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle associated with the tooltip.

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

GetTipText()

Reads this registered control's tooltip text.

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

This overload targets the current control.

IsTool(hWnd)

Tests whether a control has a tooltip registration.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle associated with the tooltip.

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

IsTool()

Tests whether this control has a tooltip registration.

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

This overload targets the current control.

SetStatusText(hWnd, sText)

Updates the status-bar text for a registered control.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle associated with the tooltip.
sText	SalString	The replacement text.

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

SetStatusText(sText)

Updates the status-bar text for this registered control.

Parameter	Type	Description
sText	SalString	The replacement text.

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

This overload targets the current control.

SetTipText(hWnd, sText)

Updates the tooltip text for a registered control.

Parameter	Type	Description
hWnd	SalWindowHandle	The window handle associated with the tooltip.
sText	SalString	The replacement text.

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

SetTipText(sText)

Updates the tooltip text for this registered control.

Parameter	Type	Description
sText	SalString	The replacement text.

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

This overload targets the current control.

Implements

Name	Description
ISalControl	Provides access to a SAL control's typed value, associated label, and modification state.
ISalEditControl	Extends the SAL control contract with validation, display formatting, edit masks, and culture settings.
ISalWindow	Exposes SAL message dispatch and runtime metadata for child controls, forms, dialogs, and MDI windows.