DiagramControl.CustomCursor Event

Occurs when the mouse cursor enters the diagram control.

Namespace: DevExpress.Xpf.Diagram

Assembly: DevExpress.Xpf.Diagram.v24.2.dll

NuGet Package: DevExpress.Wpf.Diagram

Declaration

C#

public event EventHandler<DiagramCustomCursorEventArgs> CustomCursor

VB.NET

Public Event CustomCursor As EventHandler(Of DiagramCustomCursorEventArgs)

Event Data

The CustomCursor event's data class is DiagramCustomCursorEventArgs. The following properties provide information specific to this event:

Property	Description
Cursor	Gets or sets a custom cursor.
DiagramPoint	Gets the mouse pointer position within the diagram control.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
HitInfo	Gets the information about an object located at the current mouse pointer position.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets or sets a reference to the object that raised the event. Inherited from RoutedEventArgs.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

Use the CustomCursor event to display a custom mouse cursor. The following example demonstrates a CustomCursor event handler that replaces the standard cursor.

C#

private void diagramControl_CustomCursor(object sender, DiagramCustomCursorEventArgs e) {
            e.Cursor = new Cursor("/Resources/CustomCursor.ani");
        }