SvgImageBox.ToolTip Property

Gets or sets a regular tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v24.1.dll

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

Declaration

C#

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

VB.NET

<DefaultValue("")>
<DXCategory("ToolTip")>
Public Property ToolTip As String

Property Value

Type	Default	Description
String	String.Empty	A regular tooltip displayed when a user hovers over an empty space, and over items without explicitly assigned tooltips.

Remarks

SvgImageBox supports tooltips (regular hints and super tooltips) if the ShowToolTips property is enabled.

Regular Tooltips

Use the following properties to specify regular tooltips:

• SvgImageItem.ToolTip, SvgImageItem.ToolTipTitle, and SvgImageItem.ToolTipIconType—Allow you to assign regular tooltips to individual items.

• SvgImageBox.ToolTip, SvgImageBox.ToolTipTitle, and SvgImageBox.ToolTipIconType—Allow you to display regular tooltips when a user hovers over an empty space, and over items without explicitly assigned tooltips.

Super Tooltips

Use the following properties to specify super tooltips:

• SvgImageItem.SuperTip—Allows you to assign super tooltips to individual items.
• SvgImageBox.SuperTip—Allows you to display super tooltips when a user hovers over an empty space, and over items without explicitly assigned tooltips.

Tooltip Controller

The ToolTipController property allows you to assign a stand-alone controller and modify tooltips at runtime. To do that, handle the ToolTipController.BeforeShow event. Read the e.SelectedObject property to identify which item a user’s mouse pointer hovers over, and set the corresponding e.Tooltip or e.SuperTip value. The code sample below illustrates how tooltips are assigned to SvgImageBox items in the DevExpress “SvgImage Box” Demo Center module.

C#

svgImageBox.ToolTipController = toolTipController;
toolTipController.BeforeShow += 
    new DevExpress.Utils.ToolTipControllerBeforeShowEventHandler(this.OnBeforeShowToolTip);

void OnBeforeShowToolTip(object sender, Utils.ToolTipControllerShowEventArgs e) {
    var svgImageItem = e.SelectedObject as SvgImageItem;
    if(svgImageItem == null) return;
    e.ToolTip = string.Format(
        e.ToolTip,(svgImageItem.Tag as string).ToUpper(),
        svgImageItem.Selected ? "Reserved" : "Free");
}

VB.NET

svgImageBox.ToolTipController = toolTipController
AddHandler toolTipController.BeforeShow, AddressOf OnBeforeShowToolTip

Private Sub OnBeforeShowToolTip(ByVal sender As Object, ByVal e As Utils.ToolTipControllerShowEventArgs)
    Dim svgImageItem = TryCast(e.SelectedObject, SvgImageItem)
    If svgImageItem Is Nothing Then
        Return
    End If
    e.ToolTip = String.Format(e.ToolTip,(TryCast(svgImageItem.Tag, String)).ToUpper(),If(svgImageItem.Selected, "Reserved", "Free"))
End Sub