ColumnView.GetFocusedRowCellValue(String) Method

Returns the edit value of the specified cell within the focused row. Returns null if a column with such field name is not found.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.1.dll

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

Declaration

C#

public object GetFocusedRowCellValue(
    string fieldName
)

VB.NET

Public Function GetFocusedRowCellValue(
    fieldName As String
) As Object

Parameters

Name	Type	Description
fieldName	String	A string identifying the field name of the column which contains the required cell. A NullReferenceException exception will be thrown if the underlying data source does not contain a column with the specified field name.

Returns

Type	Description
Object	An object representing the cell’s value.

Remarks

If a group row is focused this method returns null.

The currently focused row is determined by the ColumnView.FocusedRowHandle property.

To get the edit value within the currently focused cell, the ColumnView.GetFocusedValue method can be used. The ColumnView.GetRowCellValue method can be used to get the values of any column in any row.

The following methods can be used to get the displayed values of specific cells: ColumnView.GetFocusedDisplayText, ColumnView.GetFocusedRowCellDisplayText and ColumnView.GetRowCellDisplayText.

Note

Detail pattern Views do not contain data and they are never displayed within XtraGrid. So, the GetFocusedRowCellValue member must not be invoked for these Views. The GetFocusedRowCellValue 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 GetFocusedRowCellValue(String) 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#

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/CS/ScheduledTasksAPIClientDemo/MainForm.cs#L49

void showScheduledJobButton_Click(object sender, EventArgs e) {
    var selectedId = scheduledJobsView.GetFocusedRowCellValue("Id") as int?;
    if (selectedId.HasValue) {

winforms-create-editable-grid-lookup/CS/PopupContainerEditSelection/Form1.cs#L36

{
    e.Value = gridView1.GetFocusedRowCellValue("Fruit");
}

winforms-filter-lookup-column-based-on-another-lookup-column/CS/DxSample/MainForm.cs#L23

LookUpEdit editor = (LookUpEdit)view.ActiveEditor;
string countryCode = Convert.ToString(view.GetFocusedRowCellValue("CountryCode"));
editor.Properties.DataSource = DataContext.GetCitiesByCountryCode(countryCode);

VB.NET

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/VB/ScheduledTasksAPIClientDemo/MainForm.vb#L49

Private Sub showScheduledJobButton_Click(ByVal sender As Object, ByVal e As EventArgs) Handles showScheduledJobButton.Click
    Dim selectedId = CType(scheduledJobsView.GetFocusedRowCellValue("Id"), Integer?)
    If selectedId.HasValue Then

winforms-create-editable-grid-lookup/VB/PopupContainerEditSelection/Form1.vb#L28

Private Sub popupContainerEdit1_QueryResultValue(ByVal sender As Object, ByVal e As DevExpress.XtraEditors.Controls.QueryResultValueEventArgs)
    e.Value = gridView1.GetFocusedRowCellValue("Fruit")
End Sub

winforms-filter-lookup-column-based-on-another-lookup-column/VB/DxSample/MainForm.vb#L25

Dim editor As LookUpEdit = CType(view.ActiveEditor, LookUpEdit)
Dim countryCode As String = Convert.ToString(view.GetFocusedRowCellValue("CountryCode"))
editor.Properties.DataSource = DataContext.GetCitiesByCountryCode(countryCode)