SvgImageItem.ToolTip Property

Gets or sets a tooltip for this item.

Namespace: DevExpress.XtraEditors

Assembly: DevExpress.Utils.v20.2.dll

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

Declaration

C#

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

VB.NET

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

Property Value

Type	Description
String	A hint shown when a user hovers over this item.

Remarks

SvgImageItems show regular hints and super tooltips if the ShowToolTips property is enabled. To assign tooltips, use the ToolTip and/or SuperTip properties.

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 hovers, and set the correspondinge.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