ShowTitleAndDescription Method

Description

The ShowTitleAndDescription method specifies whether to show the Caption and DescriptionText of the CommandBar Control in the tool tip window.

Syntax

Public Sub ShowTitleAndDescription( _
    ByVal ShowTitleAndDescription As Boolean, _
    ByVal IconTitle As XTPToolTipIcon _
)

Parameters

ShowTitleAndDescription
True to display the Caption, DescriptionText, and Icon (specified by IconTitle) of the CommandBar Control in the tool tip window.
False to display the text stored in the ToolTipText property in the tool tip window. If False, no icon will be displayed in the tool tip window.
IconTitle
Specifies the icon to display in the tool tip window. The following values can be used:

Value	Description
xtpToolTipIconNone	No icon will be displayed in the tool tip window.
xtpToolTipIconInfo	The information icon will be displayed in the tool tip window.
xtpToolTipIconWarning	The warning icon will be displayed in the tool tip window.
xtpToolTipIconError	The error icon will be displayed in the tool tip window.

Remarks

The ShowTitleAndDescription method requires Internet Explorer 5.0 or above to be installed. The IsBalloonStyleSupported method can be used to determine if the ShowTitleAndDescription method is supported.

The XTPToolTipIcon enumeration is used to specify which icon should be displayed in the tooltip window when using the ShowTitleAndDescription method. The text that will be displayed in the tool tip window will be the Caption and DescriptionText of the CommandBar Control.

Note: The ToolTipText property is not used to display text in the tool tip window when using the ShowTitleAndDescription method for CommandBar Controls. The text stored in the ToolTip property will be displayed for all other objects.

Example

[ShowTitleAndDescription Sample (Visual Basic)]
This sample illustrates how to display a tool tip window that displays the Caption, DescriptionText, and XTPToolTipIcon.

CommandBars.ToolTipContext.ShowTitleAndDescription True, xtpToolTipIconInfo