LayoutView.GetFieldCaption(GridColumn) Method

Returns a column’s actual display caption.

Namespace : DevExpress.XtraGrid.Views.Layout

Assembly : DevExpress.XtraGrid.v25.2.dll

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

Declaration

C#
VB.NET

csharp

public virtual string GetFieldCaption(
    GridColumn column
)

Public Overridable Function GetFieldCaption(
    column As GridColumn
) As String

Parameters

Name	Type	Description
column	GridColumn

A GridColumn object

Returns

Type	Description
String

A string representing the specified column’s display caption.

Remarks

The pattern used to generate fields’ captions is specified by the View’s LayoutView.FieldCaptionFormat property. The GetFieldCaption method allows you to get the display caption for a specific column.

Note

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