Back to Devexpress

EditFormShowingEventArgs.Allow Property

windowsforms-devexpress-dot-xtragrid-dot-views-dot-grid-dot-editformshowingeventargs.md

latest4.8 KB
Original Source

EditFormShowingEventArgs.Allow Property

Gets or sets whether opening an Edit Form is allowed.

Namespace : DevExpress.XtraGrid.Views.Grid

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

csharp
public bool Allow { get; set; }
vb
Public Property Allow As Boolean

Property Value

TypeDescription
Boolean

true if opening an Edit Form is allowed; otherwise, false.

|

Remarks

When you handle the GridView.EditFormShowing event, you can get or set whether opening an Edit Form is allowed via the Allow property. Using this property, you can cancel opening an Edit Form.

Example

The following example shows how to prohibit an Edit Form from opening in specific rows.

In this example, the GridView.EditFormShowing event is handled and the Allow event parameter is set to false for orders shipped to France.

csharp
using DevExpress.XtraGrid.Views.Grid;

gridView1.EditFormShowing += new EditFormShowingEventHandler(OnEditFormShowing);
//...
private void OnEditFormShowing(object sender, EditFormShowingEventArgs e) {
    GridView view = sender as GridView;
    if (view == null) return;
    if (view.GetRowCellValue(e.RowHandle, "ShipCountry").ToString() == "France") e.Allow = false;
}
vb
Imports DevExpress.XtraGrid.Views.Grid

AddHandler GridView1.EditFormShowing, AddressOf OnEditFormShowing
'...
Private Sub OnEditFormShowing(sender As Object, e As EditFormShowingEventArgs)
    Dim view As GridView = TryCast(sender, GridView)
    If view Is Nothing Then
        Return
    End If
    If view.GetRowCellValue(e.RowHandle, "ShipCountry").ToString() = "France" Then
        e.Allow = False
    End If
End Sub

The following code snippets (auto-collected from DevExpress Examples) contain references to the Allow 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.

connect-winforms-grid-to-webapi-service/CS/WinForms.Client/MainForm.cs#L30

csharp
async void GridView1_EditFormShowing(object sender, DevExpress.XtraGrid.Views.Grid.EditFormShowingEventArgs e) {
    e.Allow = false;
    var row = gridView1.GetRow(e.RowHandle) as DevExpress.Data.Async.Helpers.ReadonlyThreadSafeProxyForObjectFromAnotherThread;

connect-winforms-grid-to-backend-using-middletier-server/CS/WinForms.Client/MainForm.cs#L82

csharp
void GridView_EditFormShowing(object sender, DevExpress.XtraGrid.Views.Grid.EditFormShowingEventArgs e) {
    e.Allow = false;

connect-winforms-grid-to-backend-using-middletier-server/VB/WinForms.Client/MainForm.vb#L54

vb
Private Sub GridView_EditFormShowing(ByVal sender As Object, ByVal e As Views.Grid.EditFormShowingEventArgs)
    e.Allow = False
    Dim employee As Employee = Nothing

See Also

RowHandle

EditFormShowing

EditFormShowingEventArgs Class

EditFormShowingEventArgs Members

DevExpress.XtraGrid.Views.Grid Namespace