ToolTipItem Class

Represents a region in a super tooltip.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v24.2.dll

Declaration

C#

public class ToolTipItem :
    BaseToolTipItem,
    IDisposable,
    ISerializable

VB.NET

Public Class ToolTipItem
    Inherits BaseToolTipItem
    Implements IDisposable,
               ISerializable

Remarks

A super tooltip consists of multiple regions (items): title, content, separator, and footer. Items are arranged one under another, each item can display an image and text. A tooltip can contain any combination of items.

Note

See the Tooltip Controller demo that illustrates super tooltips.

Tooltip Items

The following types specify the tooltip items:

• ToolTipItem — the main region in a super tooltip that displays text and/or image.
• ToolTipTitleItem — a region displayed at the top of a tooltip.
• ToolTipSeparatorItem — a horizontal line in a tooltip.

Use the properties below to specify an item’s text, image, layout, and appearance.

Text

Use the ToolTipItem object’s following properties to specify the text:

• Text — a string value that specifies the item’s text.
• AllowHtmlText — whether to parse HTML tags in the text. HTML tags allow you to format the text: size, style, hyperlinks, etc.

Image

The ToolTipItem.ImageOptions provides access to the following properties that allow you to specify the image displayed in the item:

• Image — a raster image.
• ImageIndex — an index of the image in the Images collection.
• ImageUri — a value that specifies the image’s universal resource identifier.
• SvgImage — a vector image.
• ImageToTextDistance — the indentation of the text from the image.
• Alignment — whether the image is aligned at the left or right.

You can also use the ToolTipItem.Icon to specify the item’s icon. The Icon property has priority over ImageOptions.

Layout

The ToolTipItem.LeftIndent property specifies the indentation of the content from the tooltip’s left edge.

Appearance

The item’s Appearance property provides access to appearance settings that specify the font, border and foreground colors. The default settings depend on the current skin. This property allows you to change the skin’s appearance settings.

See the Hints and Tooltips topic learn how to create SuperToolTip objects at design time and runtime.

Example

The following example demonstrates how to create a SuperToolTip object with a ToolTipItem object inside and assign it to a button.

C#

using DevExpress.Utils;
//...
//Create a new instance of the SuperToolTip object.
SuperToolTip sTooltip1 = new SuperToolTip();

//Create a new instance of the ToolTipItem object.
ToolTipItem item1 = new ToolTipItem();
//Specify the properties.
item1.Image = System.Drawing.Image.FromFile("d:\\image.bmp");
item1.Text = "This is <i>the text</i> in <b>the tooltip</b>";
item1.ImageToTextDistance = 50;
item1.AllowHtmlText = DefaultBoolean.True;

// Add the tooltip item to the SuperTooltip.
sTooltip1.Items.Add(item1);

// Assign the created SuperToolTip to a Button.
simpleButton1.SuperTip = sTooltip1;

VB.NET

Imports DevExpress.Utils
'...
'Create a new instance of the SuperToolTip object.
Dim sTooltip1 As New SuperToolTip()

'Create a new instance of the ToolTipItem object.
Dim item1 As New ToolTipItem()
'Specify the properties.
item1.Image = System.Drawing.Image.FromFile("d:\image.bmp")
item1.Text = "This is <i>the text</i> in <b>the tooltip</b>"
item1.ImageToTextDistance = 50
item1.AllowHtmlText = DefaultBoolean.[True]

' Add the tooltip item to the SuperTooltip.
sTooltip1.Items.Add(item1)

' Assign the created SuperToolTip to a Button.
simpleButton1.SuperTip = sTooltip1

Inheritance

Object

DevExpress.Utils.BaseToolTipObject

DevExpress.Utils.BaseToolTipItem

ToolTipItem

ToolTipTitleItem