ColumnView.BeginSort() Method

Prevents visual and internal data updates until the ColumnView.EndSort method is called.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

public void BeginSort()

VB.NET

Public Sub BeginSort

Remarks

This method is equivalent to the ColumnView.BeginDataUpdate method. See this topic to learn more.

Example

The code sample below iterates through grid records and reduces the “Price” column values by 10 percent.

C#

private void UpdatePrice(DevExpress.XtraGrid.Views.Base.ColumnView View) {
   // Obtain the Price column. 
   DevExpress.XtraGrid.Columns.GridColumn col = View.Columns.ColumnByFieldName("Price");
   if (col == null) return;
   View.BeginSort();
   try {
      // Obtain the number of data rows. 
      int dataRowCount = View.DataRowCount;
      // Traverse data rows and change the Price field values. 
      for (int i = 0; i < dataRowCount; i++) {
         object cellValue = View.GetRowCellValue(i, col);
         double newValue = Convert.ToDouble(cellValue) * 0.9;
         View.SetRowCellValue(i, col, newValue);
      }
   } finally { View.EndSort(); }
}

VB.NET

Private Sub UpdatePrice(ByVal View As DevExpress.XtraGrid.Views.Base.ColumnView)
   ' Obtain the Price column. 
   Dim Col As DevExpress.XtraGrid.Columns.GridColumn = View.Columns.ColumnByFieldName("Price")
   If Col Is Nothing Then Exit Sub 
   View.BeginSort()
   Try 
      ' Obtain the number of data rows. 
      Dim DataRowCount As Integer = View.DataRowCount
      ' Traverse data rows and change the Price field values. 
      Dim I As Integer 
      For I = 0 To DataRowCount - 1
         Dim CellValue As Object = View.GetRowCellValue(I, Col)
         Dim NewValue As Double = Convert.ToDouble(CellValue) * 0.9
         View.SetRowCellValue(I, Col, NewValue)
      Next 
   Finally 
      View.EndSort()
   End Try 
End Sub 

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the BeginSort() 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-edit-values-within-a-group-via-an-editable-group-row-e3065/CS/EditableGroupRow/GroupRowEdit.cs#L87

string newValue = (sender as TextEdit).Text;
View.BeginSort();
GridColumn grColumn = View.GroupedColumns[View.GetRowLevel(rowToChangeHandle)];

how-to-align-summary-values-displayed-in-a-group-row-to-the-corresponding-columns-e773/CS/WindowsApplication3/Form1.cs#L52

}
gridView1.BeginSort();
try {

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/CS/WindowsApplication3/SortForm.cs#L65

{
    view.BeginSort();
    view.ClearSorting();

VB.NET

how-to-edit-values-within-a-group-via-an-editable-group-row-e3065/VB/EditableGroupRow/GroupRowEdit.vb#L75

Dim newValue As String = (TryCast(sender, TextEdit)).Text
View.BeginSort()
Dim grColumn As GridColumn = View.GroupedColumns(View.GetRowLevel(rowToChangeHandle))

how-to-align-summary-values-displayed-in-a-group-row-to-the-corresponding-columns-e773/VB/WindowsApplication3/Form1.vb#L56

Next i
gridView1.BeginSort()
Try

how-to-show-the-sort-dialog-in-a-grid-in-a-similar-manner-as-in-excel-e2941/VB/WindowsApplication3/SortForm.vb#L61

Public Sub SaveChanges()
    view.BeginSort()
    view.ClearSorting()