GridOptionsView.ShowPreview Property

Gets or sets a value specifying whether preview sections are displayed.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[DefaultValue(false)]
[XtraSerializableProperty]
public virtual bool ShowPreview { get; set; }

VB.NET

<DefaultValue(False)>
<XtraSerializableProperty>
Public Overridable Property ShowPreview As Boolean

Property Value

Type	Default	Description
Boolean	**false**	true, to display row preview sections; otherwise, false.

Property Paths

You can access this nested property as listed below:

Object Type	Path to ShowPreview
AdvBandedGridView	.OptionsView.ShowPreview
BandedGridView	.OptionsView.ShowPreview
GridView	.OptionsView.ShowPreview

Remarks

Please refer to the Row Preview Sections topic for information on specifying preview section content.

Note

If the Row Auto-Height or Preview Sections feature is enabled, pixel-based vertical row scrolling is not in effect. See GridOptionsBehavior.AllowPixelScrolling to learn more.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ShowPreview 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#L32

gridView1.PreviewFieldName = "Description";
gridView1.OptionsView.ShowPreview = true;
StyleFormatCondition condition = new StyleFormatCondition(FormatConditionEnum.Greater, gridView1.Columns["Number"], null, 300, null, true);

how-to-provide-a-custom-datasource-for-the-print-preview-form-options-dialog-e3589/CS/CustomPrintPreview/Grid/CustomGridViewPrinting.cs#L132

void OnCheckBoxPreviewCheckStateChanged(object sender, EventArgs e) {
    CurrentView.OptionsView.ShowPreview = CheckBoxPreview.Checked;
    InvalidateImage(CheckBoxPreview);

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/CS/WindowsApplication1/ButtonPanelHelper.cs#L81

Buttons.Add(button);
linkedView.OptionsView.ShowPreview = true;

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

InitializeComponent();
myGridView1.OptionsView.ShowPreview = true;
myGridView1.OptionsView.AutoCalcPreviewLineCount = false;

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/CS/GridView_RowPreview/CustomGridView.cs#L229

protected virtual int CalcRowPreviewEditorHeight(int rowHandle, RepositoryItem item) {
    if (!View.OptionsView.ShowPreview || View.IsGroupRow(rowHandle) || View.IsFilterRow(rowHandle)) return 0;
    int res = (View.OptionsView.ShowPreviewRowLines != DevExpress.Utils.DefaultBoolean.False ? 1 : 0);

VB.NET

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

gridView1.PreviewFieldName = "Description"
gridView1.OptionsView.ShowPreview = True
Dim condition As New StyleFormatCondition(FormatConditionEnum.Greater, gridView1.Columns("Number"), Nothing, 300, Nothing, True)

how-to-provide-a-custom-datasource-for-the-print-preview-form-options-dialog-e3589/VB/CustomPrintPreview/Grid/CustomGridViewPrinting.vb#L150

Private Sub OnCheckBoxPreviewCheckStateChanged(ByVal sender As Object, ByVal e As EventArgs) Handles CheckBoxPreview.CheckStateChanged
    CurrentView.OptionsView.ShowPreview = CheckBoxPreview.Checked
    InvalidateImage(CheckBoxPreview)

how-to-show-a-panel-with-buttons-under-a-focused-row-e1957/VB/WindowsApplication1/ButtonPanelHelper.vb#L90

Buttons.Add(button)
linkedView.OptionsView.ShowPreview = True

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

InitializeComponent()
myGridView1.OptionsView.ShowPreview = True
myGridView1.OptionsView.AutoCalcPreviewLineCount = False

how-to-create-an-advbandedgridview-descendant-allows-using-repositoryitems-to-display-edit-r-e5014/VB/GridView_RowPreview/CustomGridView.vb#L299

Protected Overridable Function CalcRowPreviewEditorHeight(ByVal rowHandle As Integer, ByVal item As RepositoryItem) As Integer
    If Not View.OptionsView.ShowPreview OrElse View.IsGroupRow(rowHandle) OrElse View.IsFilterRow(rowHandle) Then
        Return 0