ColumnView.GetFocusedRowCellValue(GridColumn) Method

Returns the specified column’s edit value within the focused row. Returns null if the column is not found.

Namespace: DevExpress.XtraGrid.Views.Base

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

public object GetFocusedRowCellValue(
    GridColumn column
)

VB.NET

Public Function GetFocusedRowCellValue(
    column As GridColumn
) As Object

Parameters

Name	Type	Description
column	GridColumn	A GridColumn column which contains the required cell.

Returns

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

Remarks

If the specified column does not belong to the current view, this method will try to find a column within the current View whose field name matches the field name of the specified column and then its value will be returned. If no such column is found, this method will return null.

If a group row is focused this method also 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 snippet (auto-collected from DevExpress Examples) contains a reference to the GetFocusedRowCellValue(GridColumn) 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#

winforms-grid-popupcontaineredit-with-dynamic-content/CS/Q148684/Form1.cs#L50

PopupContainerEdit edit = (PopupContainerEdit)sender;
if ((bool)gridView1.GetFocusedRowCellValue(colUseGrid)) {
    edit.Properties.PopupControl.Controls.Add(gridEditor);

VB.NET

winforms-grid-popupcontaineredit-with-dynamic-content/VB/Q148684/Form1.vb#L53

Dim edit As PopupContainerEdit = CType(sender, PopupContainerEdit)
If CBool(gridView1.GetFocusedRowCellValue(colUseGrid)) Then
    edit.Properties.PopupControl.Controls.Add(gridEditor)