TableView.AddNewRow(Boolean) Method

Adds a new row to the GridControl‘s data source.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v24.2.dll

NuGet Package: DevExpress.Wpf.Grid.Core

Declaration

C#

public void AddNewRow(
    bool showUpdateRowButtons = false
)

VB.NET

Public Sub AddNewRow(
    showUpdateRowButtons As Boolean = False
)

Optional Parameters

Name	Type	Default	Description
showUpdateRowButtons	Boolean	False	If the Edit Entire Row mode and the New Item Row are enabled, you can set this parameter to true to allow users edit values in the new row before posting this row to the data source.

Remarks

Use the AddNewRow method to add a new row to the grid’s data source. The View reflects changes made in the data source and focuses the new record.

The GridControl does not move focus to the new record if a user focuses the Automatic Filter Row. To avoid this behavior, you can manually focus a data row and call the AddNewRow method (for example, you can use the DataViewBase.MoveLastRow method):

C#

if (tableView.FocusedRowHandle == DataControlBase.AutoFilterRowHandle)
    tableView.MoveLastRow();
tableView.AddNewRow();

VB.NET

If tableView.FocusedRowHandle = DataControlBase.AutoFilterRowHandle Then 
    tableView.MoveLastRow()
tableView.AddNewRow()

Refer to the following help topic for more information: Add and Remove Rows.

Example

The following example demonstrates how to add a new row to the GridControl and set this row’s values:

View Example: How to Add and Remove Rows in Code

1. Call the AddNewRow method to add a new row.

   This method moves focus to the New Item Row. If the New Item Row is disabled, the AddNewRow method adds an empty row at the bottom.

   XAML

   <dxg:GridControl x:Name="grid" AutoGenerateColumns="AddNew" ItemsSource="{Binding PersonList}">
       <dxg:GridControl.View>
           <dxg:TableView x:Name="view"/>
       </dxg:GridControl.View>
   </dxg:GridControl>
   <!-- -->
   <Button Click="addNewRow">Add a New Row</Button> 
   

   C#

   void addNewRow(object sender, RoutedEventArgs e) {
       view.AddNewRow();
   }
   

   VB.NET

   Private Sub addNewRow(ByVal sender As Object, ByVal e As RoutedEventArgs)
       view.AddNewRow()
   End Sub
   

   You can also use the TableViewCommands.AddNewRow command to add a new row and the GridViewBase.AddingNewRowCommand property to specify a data object and initialize its values.

2. Use the DataControlBase.NewItemRowHandle to get the new row and set its values.

   C#

   void addNewRow(object sender, RoutedEventArgs e) {
       view.AddNewRow();
       int newRowHandle = DataControlBase.NewItemRowHandle;
       grid.SetCellValue(newRowHandle, "ProductName", "New Product");
       grid.SetCellValue(newRowHandle, "CompanyName", "New Company");
       grid.SetCellValue(newRowHandle, "UnitPrice", 10);            
       grid.SetCellValue(newRowHandle, "Discontinued", false);
   } 
   

   VB.NET

   Private Sub addNewRow(ByVal sender As Object, ByVal e As RoutedEventArgs)
       view.AddNewRow()
       Dim newRowHandle As Integer = DataControlBase.NewItemRowHandle
       grid.SetCellValue(newRowHandle, "ProductName", "New Product")
       grid.SetCellValue(newRowHandle, "CompanyName", "New Company")
       grid.SetCellValue(newRowHandle, "UnitPrice", 10)
       grid.SetCellValue(newRowHandle, "Discontinued", False)
   End Sub
   

   Refer to the following help topic for more information: Obtain and Set Cell Values in Code.

3. After values are set and accepted, the new row moves according to the current filter, group, and sort settings.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the AddNewRow(Boolean) 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-initialize-a-new-row-when-only-the-editor-is-shown-e1817/CS/InitNewRow_Editing/InitNewRowOnEditingBehavior.cs#L22

isLocked = true;
AssociatedObject.AddNewRow();
isLocked = false;

VB.NET

how-to-initialize-a-new-row-when-only-the-editor-is-shown-e1817/VB/InitNewRow_Editing/InitNewRowOnEditingBehavior.vb#L27

isLocked = True
AssociatedObject.AddNewRow()
isLocked = False