GridView.PreviewFieldName Property

Gets or sets the name of the field whose values are displayed within preview sections.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

[DefaultValue("")]
[DXCategory("Appearance")]
[XtraSerializableProperty]
public string PreviewFieldName { get; set; }

VB.NET

<DefaultValue("")>
<DXCategory("Appearance")>
<XtraSerializableProperty>
Public Property PreviewFieldName As String

Property Value

Type	Default	Description
String	String.Empty	A String value specifying the name of the field whose values are displayed within preview sections.

Remarks

The View’s GridOptionsView.ShowPreview option must be enabled to make preview sections visible. Note that you can handle the GridView.CalcPreviewText event to supply custom text to preview sections or to modify the text provided by the specified field.

Please refer to the Row Preview Sections topic for additional information.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the PreviewFieldName property.

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-adjust-the-preview-row-color-based-upon-format-conditions-applied-to-the-grid-e2430/CS/WindowsFormsApplication1/Form1.cs#L31

gridControl1.ForceInitialize();
gridView1.PreviewFieldName = "Description";
gridView1.OptionsView.ShowPreview = true;

gridcontrol-how-to-implement-events-for-custom-printing-cells-and-headers-t368970/CS/GridBeforePrint/Form1.cs#L32

myGridView1.OptionsView.AutoCalcPreviewLineCount = false;
myGridView1.PreviewFieldName = "FirstName";
customerList = GetData();

VB.NET

how-to-adjust-the-preview-row-color-based-upon-format-conditions-applied-to-the-grid-e2430/VB/WindowsFormsApplication1/Form1.vb#L28

gridControl1.ForceInitialize()
gridView1.PreviewFieldName = "Description"
gridView1.OptionsView.ShowPreview = True

gridcontrol-how-to-implement-events-for-custom-printing-cells-and-headers-t368970/VB/GridBeforePrint/Form1.vb#L24

myGridView1.OptionsView.AutoCalcPreviewLineCount = False
myGridView1.PreviewFieldName = "FirstName"
customerList = GetData()