Skip to main content
All docs
V25.1
  • SvgImageBox.ShowToolTips Property

    Gets or sets whether SvgImageItem objects owned by this control can show tooltips when users hover over these items.

    Namespace: DevExpress.XtraEditors

    Assembly: DevExpress.Utils.v25.1.dll

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

    Declaration

    [DefaultValue(DefaultBoolean.Default)]
    [DXCategory("ToolTip")]
    public DefaultBoolean ShowToolTips { get; set; }

    Property Value

    Type Default Description
    DefaultBoolean Default

    Specifies whether items can show super tooltips and regular hints.

    Available values:

    Name Description Return Value
    True

    The value is true.

    0

    False

    The value is false.

    1

    Default

    The value is specified by a global option or a higher-level object.

    2

    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:

    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.

    Item tooltips in DevExpress SvgImageBox

    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");
    }
    
    See Also