DXMouseEventArgs Class

Provides data for mouse events.

Namespace: DevExpress.Utils

Assembly: DevExpress.Utils.v18.1.dll

Declaration

C#

public class DXMouseEventArgs :
    HandledMouseEventArgs

VB.NET

Public Class DXMouseEventArgs
    Inherits HandledMouseEventArgs

Related API Members

The following members accept/return DXMouseEventArgs objects:

• DXMouseEventArgs.GetMouseArgs(Control, EventArgs)
• DXMouseEventArgs.GetMouseArgs(MouseEventArgs)

Remarks

The DXMouseEventArgs class is derived from the MouseEventArgs class and extends its functionality by introducing the DXMouseEventArgs.Handled property. This property allows a mouse event to be suppressed. This can be useful when specific actions need to be performed within the mouse event handler without the mouse event being processed by the control.

To gain access to an instance of the DXMouseEventArgs type, convert a mouse event’s arguments to the DXMouseEventArgs type using the DXMouseEventArgs.GetMouseArgs static method.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the DXMouseEventArgs class.

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#

gridview-how-to-implement-north-south-and-west-east-resizing-of-filter-dropdowns-t497264/CS/DXApplication2/CustomSizablePopupHelper.cs#L18

public CustomSizablePopupHelper(IPopupSizeableForm owner) : base(owner) { }
public override DXMouseEventArgs OnMouseMove(MouseEventArgs e)
{

how-to-add-custom-buttons-to-tab-page-headers-e4255/CS/XtraTabWithButtons/BaseTabHandlerDescendant.cs#L23

bool result = base.OnMouseMove(e);
DXMouseEventArgs ee = DXMouseEventArgs.GetMouseArgs(e);
if (ViewInfo != null)

how-to-implement-the-auto-repeat-functionality-in-xtratabbedmdimanager-e2696/CS/WindowsApplication1/MyXtraTabbedMdiManager.cs#L23

    if (InButtons(mousePosition))
        ViewInfo.HeaderInfo.Buttons.ProcessEvent(new ProcessEventEventArgs(EventType.MouseDown, new DXMouseEventArgs(MouseButtons.Left, 1, mousePosition.X, mousePosition.Y, 0)));
}

how-to-create-a-custom-view-allowing-collapsing-of-band-headers-e2433/CS/BandedViewBandDefaultColumn/BandedViewBandDefaultColumn/MyBandedGridView.cs#L109

    ((DXMouseEventArgs)e).Handled = true;
}

how-to-add-a-custom-button-to-a-column-header-in-a-grid-e2793/CS/WindowsApplication3/ColumnHeaderExtender.cs#L59

    // your code here
    DXMouseEventArgs.GetMouseArgs(e).Handled = true;
}

VB.NET

gridview-how-to-implement-north-south-and-west-east-resizing-of-filter-dropdowns-t497264/VB/DXApplication2/CustomSizablePopupHelper.vb#L21

End Sub
Public Overrides Function OnMouseMove(ByVal e As MouseEventArgs) As DXMouseEventArgs
    Dim ee As DXMouseEventArgs = DXMouseEventArgs.GetMouseArgs(e)

how-to-add-custom-buttons-to-tab-page-headers-e4255/VB/XtraTabWithButtons/BaseTabHandlerDescendant.vb#L21

Dim result As Boolean = MyBase.OnMouseMove(e)
Dim ee As DXMouseEventArgs = DXMouseEventArgs.GetMouseArgs(e)
If ViewInfo IsNot Nothing Then

how-to-implement-the-auto-repeat-functionality-in-xtratabbedmdimanager-e2696/VB/WindowsApplication1/MyXtraTabbedMdiManager.vb#L21

If InButtons(mousePosition) Then
    ViewInfo.HeaderInfo.Buttons.ProcessEvent(New ProcessEventEventArgs(EventType.MouseDown, New DXMouseEventArgs(MouseButtons.Left, 1, mousePosition.X, mousePosition.Y, 0)))
End If

how-to-create-a-custom-view-allowing-collapsing-of-band-headers-e2433/VB/BandedViewBandDefaultColumn/BandedViewBandDefaultColumn/MyBandedGridView.vb#L120

    CType(e, DXMouseEventArgs).Handled = True
Else

how-to-add-a-custom-button-to-a-column-header-in-a-grid-e2793/VB/WindowsApplication3/ColumnHeaderExtender.vb#L61

    ' your code here
    DXMouseEventArgs.GetMouseArgs(e).Handled = True
End If

Inheritance

Object

EventArgs

MouseEventArgs

HandledMouseEventArgs

DXMouseEventArgs

RowClickEventArgs

NodeClickEventArgs

RowCellClickEventArgs