QueryChartCursorEventArgs.CursorImage Property

Provides an image for the custom cursor.

Namespace: DevExpress.Xpf.Charts

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

Declaration

C#

public ImageSource CursorImage { get; set; }

VB.NET

Public Property CursorImage As ImageSource

Property Value

Type	Description
ImageSource	A ImageSource object

Remarks

Use the CursorImage property to specify the appearance for a custom cursor.

Example

This example shows how to display a custom cursor when the mouse pointer is hovering over the chart control.

To accomplish this task, handle the ChartControl.QueryChartCursor event and assign your custom image (e.g., a BitmapImage object loaded from application resources) to the QueryChartCursorEventArgs.CursorImage property.

Note that you need to include your image in the project and set the QueryChartCursorEventArgs.Cursor property to None to see the custom image in the chart control.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-display-a-custom-cursor-in-the-chart-control-e3805.

MainWindow.xaml

<Window x:Class="CustomCursor.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxc="http://schemas.devexpress.com/winfx/2008/xaml/charts"
        Title="MainWindow" Height="350" Width="525" >
    <Grid>
        <dxc:ChartControl Name="chartControl1" QueryChartCursor="chartControl1_QueryChartCursor">
            <dxc:ChartControl.Diagram>
                <dxc:XYDiagram2D >
                    <dxc:XYDiagram2D.Series>
                        <dxc:BarSideBySideSeries2D >
                            <dxc:BarSideBySideSeries2D.Points>
                                <dxc:SeriesPoint Argument="C" Value="5" />
                                <dxc:SeriesPoint Argument="B" Value="3" />
                                <dxc:SeriesPoint Argument="A" Value="1" />
                            </dxc:BarSideBySideSeries2D.Points>
                        </dxc:BarSideBySideSeries2D>
                    </dxc:XYDiagram2D.Series>
                </dxc:XYDiagram2D>
            </dxc:ChartControl.Diagram>
        </dxc:ChartControl>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Windows;
using System.Windows.Input;
using System.Windows.Media.Imaging;
using DevExpress.Xpf.Charts;

namespace CustomCursor {

    public partial class MainWindow : Window {

        public MainWindow() {
            InitializeComponent();
        }

        private void chartControl1_QueryChartCursor(object sender, QueryChartCursorEventArgs e) {
            e.Cursor = Cursors.None;
            e.CursorImage = new BitmapImage(new Uri(@"/CustomCursor;component/mycursor.png", UriKind.Relative));
        }

    }

}

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Windows
Imports System.Windows.Input
Imports System.Windows.Media.Imaging
Imports DevExpress.Xpf.Charts

Namespace CustomCursor

    Partial Public Class MainWindow
        Inherits Window

        Public Sub New()
            InitializeComponent()
        End Sub

        Private Sub chartControl1_QueryChartCursor(ByVal sender As Object, ByVal e As QueryChartCursorEventArgs)
            e.Cursor = Cursors.None
            e.CursorImage = New BitmapImage(New Uri("/CustomCursor;component/mycursor.png", UriKind.Relative))
        End Sub

    End Class

End Namespace

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CursorImage 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.

C#

how-to-display-a-custom-cursor-in-the-chart-control-e3805/CS/CustomCursor/MainWindow.xaml.cs#L17

    e.Cursor = Cursors.None;
    e.CursorImage = new BitmapImage(new Uri(@"/CustomCursor;component/mycursor.png", UriKind.Relative));
}

VB.NET

how-to-display-a-custom-cursor-in-the-chart-control-e3805/VB/CustomCursor/MainWindow.xaml.vb#L19

    e.Cursor = Cursors.None
    e.CursorImage = New BitmapImage(New Uri("/CustomCursor;component/mycursor.png", UriKind.Relative))
End Sub