HierarchicalChartControlBase.ToolTipOptions Property

Gets or sets options used to display tooltips.

Namespace: DevExpress.Xpf.TreeMap

Assembly: DevExpress.Xpf.TreeMap.v24.1.dll

NuGet Package: DevExpress.Wpf.TreeMap

Declaration

C#

public ToolTipOptions ToolTipOptions { get; set; }

VB.NET

Public Property ToolTipOptions As ToolTipOptions

Property Value

Type	Description
ToolTipOptions	Contains settings that define how to display tooltips.

Remarks

The ToolTipOptions property allows you to configure the following tooltip options:

Name	Description
AutoPopDelay	Gets or sets the time interval during which the tooltip is displayed.
CloseOnClick	Indicates whether a tooltip is closed when an item is clicked.
InitialDelay	Gets or sets a delay before tooltips are invoked.
OpenMode	Specifies a user action that displays a tooltip.
Position	Specifies a tooltip position.

The code snippet below customizes tooltip options for the Sunburst Control:

XAML

<dxtm:SunburstControl.ToolTipOptions>
    <dxtm:ToolTipOptions OpenMode="OnHover" 
                         InitialDelay="0:0:0:0.1"
                         AutoPopDelay="0:0:0:5"
                         CloseOnClick="False">
        <dxtm:ToolTipOptions.Position>
            <dxtm:ToolTipRelativePosition/>
        </dxtm:ToolTipOptions.Position>
    </dxtm:ToolTipOptions>
</dxtm:SunburstControl.ToolTipOptions>

Example

The following properties allow you to customize TreeMap tooltips:

• ToolTipEnabled - indicates whether tooltips are displayed.
• ToolTipOptions - allows you to configure common tooltip options: ToolTipOptions.Position, ToolTipOptions.OpenMode, ToolTipOptions.InitialDelay and ToolTipOptions.AutoPopDelay.
• ToolTipPattern - specifies a tooltip text pattern for the leaf treemap items.
• ToolTipGroupPattern - specifies a tooltip text pattern for the group treemap items.
• ToolTipContentTemplate - specifies a data template for the leaf item tooltip’s content.
• ToolTipGroupContentTemplate - specifies a data template for the group item tooltip’s content.
• ToolTipTemplate - specifies a data template that allows you to change tooltip appearance.

MainWindow.xaml

<Window.Resources>
    <DataTemplate x:Key="tooltipContentTemplate">
        <StackPanel Orientation="Vertical"
                    Margin="8">
            <TextBlock Text="{Binding Item.Label}"
                       Foreground="White" 
                       FontSize="24"/>
            <TextBlock Text="{Binding Path=ToolTipText}"
                       Foreground="LightGray"/>
        </StackPanel>
    </DataTemplate>
    <DataTemplate x:Key="tooltipTemplate">
        <Grid>
            <Border CornerRadius="8" 
                    Background="#FF303030">
                <ContentPresenter Content="{Binding}" 
                                  ContentTemplate="{Binding ContentTemplate}"/>
            </Border>
        </Grid>
    </DataTemplate>
</Window.Resources>
<dxtm:TreeMapControl ToolTipEnabled="true"
                     ToolTipPattern="{}GDP: {V:C} millions"
                     ToolTipContentTemplate="{Binding Source={StaticResource tooltipContentTemplate}}"
                     ToolTipGroupPattern="{} Summary GDP: {V:C} millions"
                     ToolTipGroupContentTemplate="{Binding Source={StaticResource tooltipContentTemplate}}"
                     ToolTipTemplate="{Binding Source={StaticResource tooltipTemplate}}">
    <dxtm:TreeMapControl.ToolTipOptions>
        <dxtm:ToolTipOptions Position="{Binding ElementName=lbPosition, Path=SelectedValue}"
                                OpenMode="{Binding ElementName=lbOpenMode, Path=SelectedValue}">
        </dxtm:ToolTipOptions>
    </dxtm:TreeMapControl.ToolTipOptions>
</dxtm:TreeMapControl>
<ListBox Grid.Row="1"
            x:Name="lbPosition"
            DisplayMemberPath="PositionName"
            SelectedValuePath="Position"
            SelectedIndex="0">
    <local:PositionWrapper PositionName="Mouse">
        <dxtm:ToolTipMousePosition/>
    </local:PositionWrapper>
    <local:PositionWrapper PositionName="Relative">
        <dxtm:ToolTipRelativePosition Origin="0.5 0"/>
    </local:PositionWrapper>
</ListBox>
<ListBox Grid.Row="3"
            x:Name="lbOpenMode"
            DisplayMemberPath="OpenModeName"
            SelectedValuePath="OpenMode"
            SelectedIndex="0">
    <local:OpenModeWrapper OpenModeName="On Hover" 
                            OpenMode="OnHover"/>
    <local:OpenModeWrapper OpenModeName="On Click" 
                            OpenMode="OnClick"/>
</ListBox>