DateNavigator.GetHitInfo(MouseEventArgs) Method

Obtains information on the DateNavigator control’s element located at the specified point.

Namespace: DevExpress.XtraScheduler

Assembly: DevExpress.XtraScheduler.v19.2.dll

Declaration

C#

public override CalendarHitInfo GetHitInfo(
    MouseEventArgs e
)

VB.NET

Public Overrides Function GetHitInfo(
    e As MouseEventArgs
) As CalendarHitInfo

Parameters

Name	Type	Description
e	MouseEventArgs	A MouseEventArgs object that contains the test point coordinates.

Returns

Type	Description
CalendarHitInfo	A CalendarHitInfo object containing information about the element at the test point.

Remarks

Use the GetHitInfo method to obtain detailed information on the element located at the specified point within the DateNavigator control. Call the GetHitInfo method within the mouse event handler and use the CalendarHitInfo.HitTest property of the returned object to identify the element’s type.

This example uses the DateNavigator.GetHitInfo method to obtain information on the point which the mouse hovers over. The information is displayed it in the application window caption.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/how-to-implement-hit-testing-for-the-datenavigator-control-t149436

Form1.cs

private void dateNavigator1_MouseMove(object sender, MouseEventArgs e)
{
    DevExpress.XtraEditors.Calendar.CalendarHitInfo hitInfo = dateNavigator1.GetHitInfo(e);
    string s1 = hitInfo.HitTest.ToString();
    string s2 = hitInfo.HitDate.ToShortDateString();
    string s3 = hitInfo.HitPoint.ToString();

    this.Text = String.Format("HitInfo for {0} - Date: {1} Point: {2}", s1, s2, s3);
}

Form1.vb

Private Sub dateNavigator1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs) Handles dateNavigator1.MouseMove
    Dim hitInfo As DevExpress.XtraEditors.Calendar.CalendarHitInfo = dateNavigator1.GetHitInfo(e)
    Dim s1 As String = hitInfo.HitTest.ToString()
    Dim s2 As String = hitInfo.HitDate.ToShortDateString()
    Dim s3 As String = hitInfo.HitPoint.ToString()

    Me.Text = String.Format("HitInfo for {0} - Date: {1} Point: {2}", s1, s2, s3)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the GetHitInfo(MouseEventArgs) method.

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-show-a-tooltip-in-the-datenavigator-control-e471/CS/Form1.cs#L33

MouseEventArgs mea = new MouseEventArgs(e.Button, e.Clicks, cp.X, cp.Y, e.Delta);
CalendarHitInfo chi = dateNavigator1.GetHitInfo(mea);

appointment-drag-and-drop-to-datenavigator-e3893/CS/DragDropDateNavigator/Form1.cs#L71

CalendarHitInfo hitInfo = dateNavigator1.GetHitInfo(new MouseEventArgs(MouseButtons.None, 0, pt.X, pt.Y, 0));
if (hitInfo.HitTest == CalendarHitInfoType.MonthNumber)

how-to-implement-hit-testing-for-the-datenavigator-control-t149436/CS/DateNavigator_HitInfo/Form1.cs#L16

{
    DevExpress.XtraEditors.Calendar.CalendarHitInfo hitInfo = dateNavigator1.GetHitInfo(e);
    string s1 = hitInfo.HitTest.ToString();

VB.NET

how-to-show-a-tooltip-in-the-datenavigator-control-e471/VB/Form1.vb#L30

Dim mea As New MouseEventArgs(e.Button, e.Clicks, cp.X, cp.Y, e.Delta)
Dim chi As CalendarHitInfo = dateNavigator1.GetHitInfo(mea)

appointment-drag-and-drop-to-datenavigator-e3893/VB/DragDropDateNavigator/Form1.vb#L61

Dim hitInfo As CalendarHitInfo = dateNavigator1.GetHitInfo(New MouseEventArgs(MouseButtons.None, 0, pt.X, pt.Y, 0))
If hitInfo.HitTest = CalendarHitInfoType.MonthNumber Then

how-to-implement-hit-testing-for-the-datenavigator-control-t149436/VB/DateNavigator_HitInfo/Form1.vb#L14

Private Sub dateNavigator1_MouseMove(ByVal sender As Object, ByVal e As MouseEventArgs) Handles dateNavigator1.MouseMove
    Dim hitInfo As DevExpress.XtraEditors.Calendar.CalendarHitInfo = dateNavigator1.GetHitInfo(e)
    Dim s1 As String = hitInfo.HitTest.ToString()