Back to Devexpress

GridView.ShowEditorByMouse(DXMouseEventArgs) Method

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-gridview-dot-showeditorbymouse-x28-devexpress-dot-utils-dot-dxmouseeventargs-x29.md

latest3.6 KB
Original Source

GridView.ShowEditorByMouse(DXMouseEventArgs) Method

Activates an editor for the focused Row Cell and passes a mouse click to it.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

NuGet Packages : DevExpress.Win.Grid, DevExpress.Win.Navigation

Declaration

csharp
public override void ShowEditorByMouse(
    DXMouseEventArgs e = null
)
vb
Public Overrides Sub ShowEditorByMouse(
    e As DXMouseEventArgs = Nothing
)

Optional Parameters

NameTypeDefault
eDXMouseEventArgsnull

Remarks

The ShowEditorByMouse method is called automatically when a cell is clicked. It makes use of the GridView.ShowEditor method to activate the cell’s inplace editor. If the editor has been invoked successfully, a mouse click is passed to it for processing. Please refer to the CardView.ShowEditor and BaseView.ShowEditor method descriptions for details on when the focused cell’s editor cannot be invoked.

This method is used internally. Generally, you will have no need to use it in your applications.

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

winforms-grid-multi-cell-editing/CS/MultiSelectionEditingHelper.cs#L94

csharp
DXMouseEventArgs.GetMouseArgs(e).Handled = true;
    view.ShowEditorByMouse();
}

winforms-grid-multi-cell-editing/VB/MultiSelectionEditingHelper.vb#L83

vb
DXMouseEventArgs.GetMouseArgs(e).Handled = True
    view.ShowEditorByMouse()
End If

See Also

ShowEditorByKey(KeyEventArgs)

ShowEditorByKeyPress(KeyPressEventArgs)

GridView Class

GridView Members

DevExpress.XtraGrid.Views.Grid Namespace