VGridControlBase.SetCellValue(BaseRow, Int32, Object) Method

Assigns a value to a cell.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v20.2.dll

NuGet Package: DevExpress.Win.VerticalGrid

Declaration

C#

public virtual void SetCellValue(
    BaseRow gridRow,
    int recordIndex,
    object value
)

VB.NET

Public Overridable Sub SetCellValue(
    gridRow As BaseRow,
    recordIndex As Integer,
    value As Object
)

Parameters

Name	Type	Description
gridRow	BaseRow	The row that contains the cell.
recordIndex	Int32	The index of the record that contains the cell.
value	Object	An object that specifies the cell’s new value.

Remarks

Use the GetCellValue or SetCellValue method to obtain or set a cell value. To identify the cell, use the field name (which specifies a row) and record index (which specifies a column). You can also use an EditorRow, MultiEditorRow, or RowProperties object to specify a row. For multi-editor rows (which display multiple cells in a single column), you should also specify the cell index. The image below illustrates cells in a single- and multi-editor row.

C#

// Cell is identified by a field name and record index.
vGridControl.SetCellValue(fieldName: "Name", recordIndex: 0, value: "Touareg");
// Cell is identified by a single-editor row object and record index.
vGridControl.SetCellValue(gridRow: erName, recordIndex: 0, value: "Touareg");
// Cell is identified by a multi-editor row object, record index and cell index.
vGridControl.SetCellValue(meRow: merTransmmision, recordIndex: 0, cellIndex: 1, value: 8);
// Cell is identified by a row properties object and record index.
vGridControl.SetCellValue(props: merpTransmissionSpeeds, recordIndex: 0, value: 8);

VB.NET

' Cell is identified by a field name and record index.
vGridControl1.SetCellValue(feildName:= "Name", recordIndex:= 0, value:= "Touareg")
' Cell is identified by a single-editor row object and record index.
vGridControl1.SetCellValue(gridRow:= erName, recordIndex:= 0, value:= "Touareg")
' Cell is identified by a multi-editor row object, record index and cell index.
vGridControl1.SetCellValue(meRow:= merTransmmision, recordIndex:= 0, cellIndex:= 1, value:= 8)
' Cell is identified by a row properties object and record index.
vGridControl1.SetCellValue(props:= merpTransmissionSpeeds, recordIndex:= 0, value:= 8)

If you obtain or set the focused row’s value, check if the focused row is an EditorRow or MultiEditorRow, and then use the method’s corresponding overload.

C#

string focusedCellValue = string.Empty;
if (vGridControl1.FocusedRow is DevExpress.XtraVerticalGrid.Rows.EditorRow)
   focusedCellValue = vGridControl1.GetCellValue(vGridControl1.FocusedRow, vGridControl1.FocusedRecord).ToString();

VB.NET

Dim focusedCellValue As String = String.Empty
If TypeOf VGridControl1.FocusedRow Is DevExpress.XtraVerticalGrid.Rows.EditorRow Then
    focusedCellValue = VGridControl1.GetCellValue(VGridControl1.FocusedRow, VGridControl1.FocusedRecord).ToString()
End If

Important

If the specified value’s type and the data field’s type do not match, the InvalidValueException event is raised. See the following topic for more information: Validation.

Example

The following sample code handles the VGridControlBase.CellValueChanged event to sum up the prices of the selected games in the purchase order list.

C#

using DevExpress.XtraVerticalGrid;
using DevExpress.XtraVerticalGrid.Rows;
using DevExpress.XtraVerticalGrid.Events;

private void vGridControl1_CellValueChanged(object sender, CellValueChangedEventArgs e) {
   double sum = 0;
   BaseRow row = vGridControl1.GetFirst();
   while (vGridControl1.GetNext(row) != null){
      if (row.XtraRowTypeID == 2){
         if (Convert.ToBoolean(vGridControl1.GetCellValue(row as MultiEditorRow, 0, 0)) == true)
            sum += Convert.ToDouble(vGridControl1.GetCellValue(row as MultiEditorRow, 0, 1));
      }
      row = vGridControl1.GetNext(row);
   }
   vGridControl1.SetCellValue(rowPrice, 0, sum);
}

VB.NET

Imports DevExpress.XtraVerticalGrid
Imports DevExpress.XtraVerticalGrid.Rows
Imports DevExpress.XtraVerticalGrid.Events

Private Sub VGridControl1_CellValueChanged(ByVal sender As Object, _
ByVal e As CellValueChangedEventArgs) Handles VGridControl1.CellValueChanged
   Dim sum As Double = 0
   Dim row As BaseRow = VGridControl1.GetFirst()
   While Not VGridControl1.GetNext(row) Is Nothing
      If row.XtraRowTypeID = 2 Then
         If Convert.ToBoolean(VGridControl1.GetCellValue(row, 0, 0)) = True Then
            sum = sum + Convert.ToDouble(VGridControl1.GetCellValue(row, 0, 1))
         End If
      End If
      row = VGridControl1.GetNext(row)
   End While
   VGridControl1.SetCellValue(rowPrice, 0, sum)
End Sub

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the SetCellValue(BaseRow, Int32, Object) 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-provide-in-place-editors-for-row-headers-in-a-vertical-grid-t244577/CS/S170863/Form1.cs#L39

    for(int i = 0; i < vGridControl1.RecordCount; i++)
        vGridControl1.SetCellValue(vGridControl1.GetRowByFieldName("Check"), i, (sender as CheckEdit).Checked);
}

how-to-provide-in-place-editors-for-row-headers-in-the-vertical-grid-t493645/CS/S170863/Form1.cs#L30

    for(int i = 0; i < vGridControl1.RecordCount; i++)
        vGridControl1.SetCellValue(vGridControl1.GetRowByFieldName("Check"), i, (sender as CheckEdit).Checked);
}

how-to-implement-newitemrow-in-vgridcontrol-e4230/CS/VGridControl/CustomVGridControl/VGridControlDescendant.cs#L69

this.FocusedRecordCellIndex = e.CellIndex;
this.SetCellValue(e.Row, RecordCount - 1, e.Value);
this.ShowEditor();

VB.NET

how-to-provide-in-place-editors-for-row-headers-in-a-vertical-grid-t244577/VB/S170863/Form1.vb#L41

For i As Integer = 0 To vGridControl1.RecordCount - 1
    vGridControl1.SetCellValue(vGridControl1.GetRowByFieldName("Check"), i, (TryCast(sender, CheckEdit)).Checked)
Next i

how-to-provide-in-place-editors-for-row-headers-in-the-vertical-grid-t493645/VB/S170863/Form1.vb#L28

For i As Integer = 0 To vGridControl1.RecordCount - 1
    vGridControl1.SetCellValue(vGridControl1.GetRowByFieldName("Check"), i, (TryCast(sender, CheckEdit)).Checked)
Next i

how-to-implement-newitemrow-in-vgridcontrol-e4230/VB/VGridControl/CustomVGridControl/VGridControlDescendant.vb#L62

Me.FocusedRecordCellIndex = e.CellIndex
Me.SetCellValue(e.Row, RecordCount - 1, e.Value)
Me.ShowEditor()