ColumnView.IsNewItemRow(Int32) Method

Indicates whether the specified row/card is the New Item Row/Card.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v23.2.dll

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

Declaration

C#

public bool IsNewItemRow(
    int rowHandle
)

VB.NET

Public Function IsNewItemRow(
    rowHandle As Integer
) As Boolean

Parameters

Name	Type	Description
rowHandle	Int32	The handle of the inspected row/card.

Returns

Type	Description
Boolean	true if the specified row/card is used to enter a new record; otherwise, false.

Remarks

The new item row is used to enter a new record within a View. The handle of the new item row is identified by the static GridControl.NewItemRowHandle field. For more information on row handles, refer to the Rows document.

For Grid Views, the new item row can be displayed by setting the GridOptionsView.NewItemRowPosition option to NewItemRowPosition.Top or NewItemRowPosition.Bottom.

If the new item row is hidden within a Grid View or Card View this row will be displayed when the ColumnView.AddNewRow method is called or the “+” button within the data navigator is clicked.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the IsNewItemRow member must not be invoked for these Views. The IsNewItemRow member can only be used with Views that display real data within the Grid Control. Use the following methods to access these Views with which an end user interacts at runtime.

• GridControl.MainView - returns the top most View in a grid;
• GridControl.FocusedView - returns the focused View;
• GridControl.DefaultView - returns the currently maximized View;
• the sender parameter of View specific events;
• GridView.GetDetailView - returns a detail clone View for a specific master row.

Related GitHub Examples

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

winforms-grid-initialize-new-item-row-on-start-editing/CS/WindowsApplication73/Form1.cs#L35

GridView view = sender as GridView;
if (view.IsNewItemRow(view.FocusedRowHandle) && view.FocusedColumn.FieldName != "ID")
    view.ActiveEditor.IsModified = true;

winforms-grid-auto-add-new-row-after-editing-last-cell/CS/Form1.cs#L80

{
    if (_View.IsNewItemRow(_View.FocusedRowHandle)) {
        _View.PostEditor();

VB.NET

winforms-grid-initialize-new-item-row-on-start-editing/VB/WindowsApplication73/Form1.vb#L27

    Dim view As GridView = TryCast(sender, GridView)
    If view.IsNewItemRow(view.FocusedRowHandle) AndAlso Not Equals(view.FocusedColumn.FieldName, "ID") Then view.ActiveEditor.IsModified = True
End Sub

winforms-grid-auto-add-new-row-after-editing-last-cell/VB/Form1.vb#L73

If _View.FocusedColumn.VisibleIndex = _View.VisibleColumns.Count - 1 Then
    If _View.IsNewItemRow(_View.FocusedRowHandle) Then
        _View.PostEditor()