A newer version of this page is available. Switch to the current version.

BaseLayoutItemOptionsToolTip.ToolTip Property

Specifies the text of the tooltip displayed when the mouse cursor hovers over the layout item's caption, and by default over its image.

Namespace: DevExpress.XtraLayout

Assembly: DevExpress.XtraLayout.v19.2.dll

Declaration

[XtraSerializableProperty]
[DefaultValue("")]
public string ToolTip { get; set; }

Property Value

Type Default Description
String

String.Empty

A string that specifies the tooltip's text.

Property Paths

You can access this nested property as listed below:

Remarks

The ToolTip property specifies the tooltip text to be displayed when the mouse cursor hovers over the layout item's caption, and by default over its image. The BaseLayoutItemOptionsToolTip.ToolTipTitle property specifies the tooltip's title, and the BaseLayoutItemOptionsToolTip.ToolTipIconType property specifies the type of icon to be displayed in the tooltip. If the ToolTip property is set to an empty string, the ToolTipTitle and ToolTipIconType properties are not in effect.

To provide a different tooltip for the layout item's image, use the BaseLayoutItemOptionsToolTip.IconToolTip property. If IconToolTip property is not set to an empty string, this tooltip is displayed when hovering over the layout item's image, while the tooltip specified by the ToolTip property is only displayed when hovering over the layout item's caption. If the IconToolTip property is set to an empty string, the tooltip specified by the ToolTip property is displayed when hovering both the caption and image.

Setting the BaseLayoutItemOptionsToolTip.EnableIconToolTip property to false prevents any tooltip for the layout item's image from being displayed.

See Also