ToolTipInfo.ToolTipText Property

Gets the hint for the tree map item located at the specified point on a map.

Namespace: DevExpress.Xpf.TreeMap

Assembly: DevExpress.Xpf.TreeMap.v18.2.dll

Declaration

C#

public string ToolTipText { get; }

VB.NET

Public ReadOnly Property ToolTipText As String

Property Value

Type	Description
String	A String value representing the text displayed when the mouse pointer is over a map item.

Example

The following properties allow you to customize TreeMap tooltips.

• TreeMapControl.ToolTipEnabled - specifies the value indicating whether or not tooltips are shown.
• TreeMapControl.ToolTipOptions - allows you to configure common tooltip options such as ToolTipOptions.Position, ToolTipOptions.OpenMode, ToolTipOptions.InitialDelay and ToolTipOptions.AutoPopDelay.
• TreeMapControl.ToolTipPattern - specifies a pattern for tooltip text of the leaf tree map items. This text will be stored by the ToolTipInfo.ToolTipText property.
• TreeMapControl.ToolTipGroupPattern - specifies a pattern for tooltip text of the group tree map items. This text will be stored by the TreeMapControl.ToolTipPattern property.
• TreeMapControl.ToolTipContentTemplate - specifies a data template for a leaf item tooltip’s content. Note that the content is represented by the ToolTipInfo object.
• TreeMapControl.ToolTipGroupContentTemplate - specifies a data template for a group item tooltip’s content. Note that the content is represented by the ToolTipInfo object.
• TreeMapControl.ToolTipTemplate - specifies a data template that allows you to change the appearance of tooltips.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-customize-treemap-tooltips-t308914.

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>