VGridControlBase.GetCellValue(BaseRow, Int32) Method

Returns the value of a cell.

Namespace: DevExpress.XtraVerticalGrid

Assembly: DevExpress.XtraVerticalGrid.v23.2.dll

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

Declaration

C#

public virtual object GetCellValue(
    BaseRow row,
    int recordIndex
)

VB.NET

Public Overridable Function GetCellValue(
    row As BaseRow,
    recordIndex As Integer
) As Object

Parameters

Name	Type	Description
row	BaseRow	The row that contains the cell.
recordIndex	Int32	The index of the record that contains the cell.

Returns

Type	Description
Object	An object that specifies the cell’s value. null (Nothing in Visual Basic) if no cell is found.

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 change the processed row’s style if its summary data cells value is greater than 100,000. To get a cell’s value, the code uses the VGridControlBase.GetCellValue method.

C#

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

private void vGridControl1_CellValueChanged(object sender, CellValueChangedEventArgs e) {
   double sum = 0;
   for (int i = 0; i < vGridControl1.RecordCount; i++)
      sum += Convert.ToDouble(vGridControl1.GetCellValue(e.Row, i));
   if (sum > 100000)
      e.Row.Appearance.BackColor = Color.Red;
   else
      e.Row.Appearance.Options.UseBackColor = false;
}

VB.NET

Imports DevExpress.Utils
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 i As Integer
   For i = 0 To i < VGridControl1.RecordCount
      sum = sum + Convert.ToDouble(VGridControl1.GetCellValue(e.Row, i))
   Next i
   If sum > 100000 Then
      e.Row.Appearance.BackColor = Color.Red
   Else
      e.Row.Appearance.Options.UseBackColor = False
   End If
End Sub