GridOptionsView.AllowCellMerge Property

Gets or sets whether neighboring cells with identical values merge.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v19.1.dll

Declaration

C#

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

VB.NET

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

Property Value

Type	Default	Description
Boolean	**false**	true, to allow neighboring cells with identical values to merge; otherwise, false.

Property Paths

You can access this nested property as listed below:

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

Remarks

The AllowCellMerge property controls the availability of the cell merge feature. If it is set to true this feature is enabled and neighboring cells with identical values may be merged.

When cell merging is enabled, you can still prevent cells in a specific column from being merged by setting the column’s OptionsColumn.AllowMerge property to DefaultBoolean.False.

Custom cell merging can also be implemented by handling the View’s GridView.CellMerge event.

When cell merging is enabled, specific features (such as cell editing, row multiple selection, etc.) aren’t available. See the Cells topic for more information.

An AdvBandedGridView View does not support the Cell Merging feature, because this View allows column cells to be arranged in several lines. Thus, cells that belong to a single column may not be neighbors. If it’s necessary to have bands and the Cell Merging feature, use the BandedGridView View instead.

Note

If the GridOptionsView.ShowPreview option is set to true, neighboring cells with identical values cannot be merged regardless of the AllowCellMerge property’s value.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the AllowCellMerge 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-edit-merged-cells-in-gridview-e4117/CS/MyGridControl/MyGridView.cs#L16

{
    OptionsView.AllowCellMerge = true;
}

how-to-merge-grid-cells-e559/CS/WindowsApplication93/Form1.cs#L23

    dataTable1.Rows.Add(new object[] {i %5, "Product " + i, i %7 });
gridView1.OptionsView.AllowCellMerge = true;
for (int i = 0; i < gridView1.Columns.Count; i++)

how-to-use-different-colors-in-even-and-odd-rows-when-gridview-rows-are-merged-e3833/CS/Form1.cs#L43

gridControl1.DataSource = someDt;
gridView1.OptionsView.AllowCellMerge = true;
gridControl1.ForceInitialize();

VB.NET

how-to-edit-merged-cells-in-gridview-e4117/VB/MyGridControl/MyGridView.vb#L17

    MyBase.New(grid)
    OptionsView.AllowCellMerge = True
End Sub

how-to-merge-grid-cells-e559/VB/WindowsApplication93/Form1.vb#L22

Next i
gridView1.OptionsView.AllowCellMerge = True
For i As Integer = 0 To gridView1.Columns.Count - 1