BarItem.Hint Property

Gets or sets the data representing the description of the bar item’s hint. This is a dependency property.

Namespace: DevExpress.Xpf.Bars

Assembly: DevExpress.Xpf.Core.v20.2.dll

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

Declaration

C#

public object Hint { get; set; }

VB.NET

Public Property Hint As Object

Property Value

Type	Description
Object	The data representing the description of the bar item’s hint.

Remarks

Bar items support regular hints and SuperTips. A SuperTip, if specified, has a higher priority than a regular hint.

A regular hint displays a BarItem’s caption (BarItem.Content), glyph (BarItem.Glyph), and the Hint object. If the Hint property is not specified, a regular hint is not displayed.

A SuperTip is an expandable tooltip that supports multiple regions. Tooltip regions are arranged one under another, and each can display a specific object and graphics. To specify a SuperTip for an item, use the BarItem.SuperTip property.

The BarManager.ShowScreenTips and BarItem.ShowScreenTip properties allow you to disable hints/SuperTips.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Hint property.

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.

XAML

Reporting_how-to-remove-standard-bar-items-and-add-custom-ones-to-the-documentviewer-toolbar-e2974/CS/WpfApplication1/MainWindow.xaml#L48

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biOpen" Content="{dxp:PrintingStringId StringId=Open}" Command="{Binding Model.OpenCommand, ElementName=documentViewer1, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Open_16x16.png}" Hint="{dxp:PrintingStringId StringId=Open_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Open_32x32.png}"/>
    <dxb:BarButtonItem x:Name="biSave" Content="{dxp:PrintingStringId StringId=Save}" Command="{Binding Model.SaveCommand, ElementName=documentViewer1, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Save_16x16.png}" Hint="{dxp:PrintingStringId StringId=Save_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Save_32x32.png}"/>

Reporting_how-to-show-a-ribbon-preview-window-for-link-e4407/CS/RibbonPrintPreviewDemo/MainWindow.xaml#L48

<dxb:BarManager.Items>
    <dxb:BarButtonItem x:Name="biOpen" Content="{dxp:PrintingStringId StringId=Open}" Command="{Binding Model.OpenCommand, ElementName=viewer, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Open_16x16.png}" Hint="{dxp:PrintingStringId StringId=Open_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Open_32x32.png}" />
    <dxb:BarButtonItem x:Name="biSave" Content="{dxp:PrintingStringId StringId=Save}" Command="{Binding Model.SaveCommand, ElementName=viewer, FallbackValue={StaticResource disabledCommand}}" Glyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Save_16x16.png}" Hint="{dxp:PrintingStringId StringId=Save_Hint}" LargeGlyph="{dxp:PrintingResourceImage ResourceName=Images/BarItems/Save_32x32.png}" />

wpf-create-a-ribboncontrol/CS/RibbonControl_Ex/MainWindow.xaml#L120

Description="Creates a new document."
Hint="Creates a blank document."
RibbonStyle="Large"/>

dxrichedit-for-wpf-how-to-implement-a-custom-command-and-bind-it-to-the-standard-bar-item-e3785/CS/MainWindow.xaml#L36

    <!--Custom BarButtonItem-->
    <dxb:BarButtonItem Command="{x:Static local:CustomRichEditUICommand.CustomCommand}" CommandParameter="{Binding ElementName=richEditControl1}" Name="biShowWordsCount" LargeGlyph="pack://application:,,,/Images/words.png" Content="Words Count" Hint="Shows the number of words in the document." />
</dxb:BarManager.Items>

how-to-customize-the-merge-field-collection-and-perform-mail-merge-using-the-ilist-data-so-t532297/CS/SimpleDataMerge/MainWindow.xaml#L36

<dxb:BarButtonItem Content="Customize Merge Fields"
                       Hint="Customize Merge Fields"
                       Glyph="/SimpleDataMerge;component/Images/CustomizeMergeField_16x16.png"