Skip to content

ShowTitleAndDescription Method

Description

The ShowTitleAndDescription method specifies whether to show the ToolTip and Description of the PropertyGridItem in the tool tip window.

Syntax

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

Parameters

  • ShowTitleAndDescription
    True to display the ToolTip, Description, and Icon (specified by IconTitle) of the PropertyGridItem in the tool tip window.
    False to display the text stored in the ToolTip 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 .
xtpToolTipIconWarning The warning icon .
xtpToolTipIconError The error icon .

Remarks

Both ToolTip and Description must be set for ShowTitleAndDescription to have an effect. Otherwise, only the ToolTip text will be displayed in the tooltip.

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 ToolTip and Description of the PropertyGridItem.

Example

ShowTitleAndDescription Sample (Visual Basic)

This sample illustrates how to display a tool tip window that displays the ToolTip, Description, and XTPToolTipIcon.

PropertyGrid.ToolTipContext.ShowTitleAndDescription True, xtpToolTipIconInfo

Set Item = Category.AddChildItem(PropertyItemBool, "SaveOnClose", True)
Item.Tooltip = "SaveOnClose"
Item.Description = "Specifies whether to save the document when it is closed."

See Also


Copyright (c) 1998-2024 Codejock Technologies. All rights reserved.