SuperToolTip.Setup(SuperToolTipSetupArgs) Method

Creates tooltip items based on the specified setup information.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.2.dll

Declaration

C#

public virtual void Setup(
    SuperToolTipSetupArgs info
)

VB.NET

Public Overridable Sub Setup(
    info As SuperToolTipSetupArgs
)

Parameters

Name	Type	Description
info	DevExpress.Utils.SuperToolTipSetupArgs	A DevExpress.Utils.SuperToolTipSetupArgs object which contains initialization information.

Remarks

The Setup method removes existing tooltip items by clearing the SuperToolTip.Items collection. Then, it adds new tooltip items to the SuperToolTip.Items collection based on the information provided by the info parameter.

A DevExpress.Utils.SuperToolTipSetupArgs object provides the Title, Contents and Footer properties which represent tooltip items. The Setup method copies these tooltip items to the SuperToolTip.Items collection, provided that these properties have been initialized.

In addition, the DevExpress.Utils.SuperToolTipSetupArgs object contains the AllowHtmlText property. The Setup method copies this property’s value to the SuperToolTip’s SuperToolTip.AllowHtmlText property.

Example

The following example demonstrates a way of creating a SuperToolTip object with two tooltip items. The first item will display the “Edit Popup Menu” string. The second item will contain an image and the “Show the Edit popup menu” text.

The example shows two ways of adding tooltip items to a SuperToolTip object.

• explicitly adding items to the SuperToolTip.Items collection;
• using the SuperToolTip.Setup method.

C#

using DevExpress.Utils;

// The component used to load images from a form's resources.
System.ComponentModel.ComponentResourceManager resources = 
  new System.ComponentModel.ComponentResourceManager(typeof(Form1));
// The image to display within a SuperTooltip.
Image resImage = ((System.Drawing.Image)(resources.GetObject("resource.Image1")));

// Method 1
SuperToolTip sTooltip1 = new SuperToolTip();
// Create a tooltip item that represents a header.
ToolTipTitleItem titleItem1 = new ToolTipTitleItem();
titleItem1.Text = "Edit Popup Menu";
// Create a tooltip item that represents the SuperTooltip's contents.
ToolTipItem item1 = new ToolTipItem();
item1.Image = resImage;
item1.Text = "Show the Edit popup menu";
// Add the tooltip items to the SuperTooltip.
sTooltip1.Items.Add(titleItem1);
sTooltip1.Items.Add(item1);

// Assign the created SuperToolTip to a BarItem.
barItem1.SuperTip = sTooltip1;

// Method 2
SuperToolTip sTooltip2 = new SuperToolTip();
// Create an object to initialize the SuperToolTip.
SuperToolTipSetupArgs args = new SuperToolTipSetupArgs();
args.Title.Text = "Edit Popup Menu";
args.Contents.Text = "Show the Edit popup menu";
args.Contents.Image = resImage;
sTooltip2.Setup(args);

// Assign the created SuperToolTip to a BarItem.
barItem2.SuperTip = sTooltip2;

VB.NET

Imports DevExpress.Utils

' The component used to load images from a form's resources.
Dim resources As System.ComponentModel.ComponentResourceManager = _
  New System.ComponentModel.ComponentResourceManager(GetType(Form1))
' The image to display within a SuperTooltip.
Dim resImage As Image = CType(resources.GetObject("resource.Image1"), System.Drawing.Image)

' Method 1
Dim sTooltip1 As SuperToolTip = New SuperToolTip
' Create a tooltip item that represents a header.
Dim titleItem1 As ToolTipTitleItem = New ToolTipTitleItem
titleItem1.Text = "Edit Popup Menu"
' Create a tooltip item that represents the SuperTooltip's contents.
Dim item1 As ToolTipItem = New ToolTipItem
item1.Image = resImage
item1.Text = "Show the Edit popup menu"
' Add the tooltip items to the SuperTooltip.
sTooltip1.Items.Add(titleItem1)
sTooltip1.Items.Add(item1)

' Assign the created SuperToolTip to a BarItem.
barItem1.SuperTip = sTooltip1

' Method 2
Dim sTooltip2 As SuperToolTip = New SuperToolTip
' Create an object to initialize the SuperToolTip.
Dim args As SuperToolTipSetupArgs = New SuperToolTipSetupArgs
args.Title.Text = "Edit Popup Menu"
args.Contents.Text = "Show the Edit popup menu"
args.Contents.Image = resImage
sTooltip2.Setup(args)

' Assign the created SuperToolTip to a BarItem.
barItem2.SuperTip = sTooltip2

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Setup(SuperToolTipSetupArgs) method.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

VB.NET

how-to-provide-supertooltip-with-design-time-support-for-any-control-e2311/VB/E2311/Helper/MyNavBarSuperTipHelper.vb#L31

args.Title.Text = hi.Link.Caption
superTip.Setup(args)
e.Info.SuperTip = superTip

how-to-customize-the-tooltips-shown-for-appointments-e155/VB/AppointmentToolTips/Form1.vb#L69

args.Footer.Text = "SuperTip"
SuperTip.Setup(args)
e.SuperTip = SuperTip

C#

how-to-customize-the-tooltips-shown-for-appointments-e155/CS/AppointmentToolTips/Form1.cs#L67

args.Footer.Text = "SuperTip";
SuperTip.Setup(args);
e.SuperTip = SuperTip;