Skip to main content

ToolTipController.IconType Property

OBSOLETE

This property is obsolete. Each BaseControl descendant has the BaseControl.ToolTipIconType property which can be used to specify the tooltip icon type for this editor. Thus it's possible to provide different icon types for different controls.

Gets or sets the tooltip icon type. This property is obsolete, use ToolTipIconType instead.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v23.2.dll

NuGet Packages: DevExpress.Utils, DevExpress.Wpf.Core

Declaration

[Browsable(false)]
[DefaultValue(ToolTipIconType.None)]
[EditorBrowsable(EditorBrowsableState.Never)]
[Obsolete("This property is obsolete. Each BaseControl descendant has the BaseControl.ToolTipIconType property which can be used to specify the tooltip icon type for this editor. Thus it's possible to provide different icon types for different controls.")]
public ToolTipIconType IconType { get; set; }

Property Value

Type Default Description
ToolTipIconType None

The ToolTipIconType enumerator.

Available values:

Name Description
Application

A tooltip contains the default application icon.

Asterisk

A tooltip contains the system asterisk icon.

Error

A tooltip contains the system error icon.

Exclamation

A tooltip contains the system exclamation icon.

Hand

A tooltip contains the system hand icon.

Information

A tooltip contains the system information icon.

Question

A tooltip contains the system question icon.

Warning

A tooltip contains the system warning icon.

A tooltip contains the Windows logo icon.

None

A tooltip contains no predefined icon.

Remarks

DevExpress controls support regular and super tooltips. If the ShowToolTips option is enabled, tooltips are shown when the mouse pointer hovers over the control.

Use the following properties to specify a regular tooltip’s content:

  • ToolTip — A regular tooltip’s text. If the text is not specified, the tooltip is not displayed even if the title is specified. You can use line breaks in regular tooltips. Use the AllowHtmlTextInToolTip property to specify whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.
  • ToolTipTitle — A regular tooltip’s title. If the title is not specified, it is not displayed.
  • ToolTipIconType — A regular tooltip’s predefined icon. Use the controller’s IconSize property to specify the image size.

    image

    To display a custom image in all regular tooltips, use the controller’s ImageList and ImageIndex properties.

    To display a custom image in a specific regular tooltip, handle the BeforeShow event. Use the ImageOptions event argument to assign a raster or vector image to the processed tooltip.

Use the SuperTip property to assign a super tooltip to a control. Enable the AllowHtmlText property to use HTML tags in the super tooltip.

To replace regular tooltips with super tooltips, set the ToolTipController.ToolTipType property to SuperTip. The controller automatically converts regular tooltips to super tooltips. To access this property, you can use the DefaultToolTipController component or a custom controller assigned to the ToolTipController property. See the following topic for more information: Hints and Tooltips.

See Also