GridView.CalcRowHeight Event

Enables you to provide custom heights for individual rows.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v18.2.dll

Declaration

C#

[DXCategory("Appearance")]
public event RowHeightEventHandler CalcRowHeight

VB.NET

<DXCategory("Appearance")>
Public Event CalcRowHeight As RowHeightEventHandler

Event Data

The CalcRowHeight event's data class is RowHeightEventArgs. The following properties provide information specific to this event:

Property	Description
RowHandle	Gets the handle of the row whose height is to be specified.
RowHeight	Gets or sets the row’s height.

Remarks

By default, the height of all rows is fixed and is specified by the GridView.RowHeight and GridView.GroupRowHeight properties. These properties set the height of data rows and group rows respectively.

The GridOptionsView.RowAutoHeight setting can be used to enable the row auto height feature, which automatically applies the “best” height to rows to display row contents in their entirety. In this mode, different rows may have different heights.

To specify the height of individual rows based on custom logic, handle the CalcRowHeight event. The event is raised repeatedly for each row. The currently processed row is specified by the event’s RowHeightEventArgs.RowHandle parameter. To change the row’s height, assign the required value to the RowHeightEventArgs.RowHeight parameter.

Note

If you subscribe to this event at runtime, your event handler may not be called immediately. The event handler will be raised after the grid’s layout is changed. You can manually invoke the layout change action, and thus your CalcRowHeight event handler, by calling the BaseView.LayoutChanged method after the event subscription.

Example

The following code demonstrates a GridView.CalcRowHeight event handler.

This event is used to specify heights of individual rows. It is assumed that a View (gridView1) displays data from the DataView data source, which contains the RowHeight column. This column specifies the height to set for a specific row.

C#

using DevExpress.XtraGrid.Views.Grid;

private void gridView1_CalcRowHeight(object sender, RowHeightEventArgs e) {
    GridView view = sender as GridView;
    if (view == null) return;
    if(e.RowHandle >= 0)
        e.RowHeight = (int)view.GetDataRow(e.RowHandle)["RowHeight"];
}

VB.NET

Imports DevExpress.XtraGrid.Views.Grid

Private Sub GridView1_CalcRowHeight(ByVal sender As Object, _
ByVal e As RowHeightEventArgs) Handles GridView1.CalcRowHeight
   Dim view As GridView = sender
   If view Is Nothing Then
       Return
   End If
   If e.RowHandle >= 0 Then
       e.RowHeight = view.GetDataRow(e.RowHandle)("RowHeight")
   End If
End Sub

Related GitHub Examples

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

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-provide-the-capability-to-create-fixed-rows-in-the-gridview-e3045/CS/SplitDescendantWithExtension/FixedRowsExtension.cs#L70

gridViewPanel2.PopupMenuShowing += gridViewPanel2_PopupMenuShowing;
gridViewPanel1.CalcRowHeight += gridViewPanel2_CalcRowHeight;
gridViewPanel2.CalcRowHeight += gridViewPanel2_CalcRowHeight;

pictureedit-how-to-choose-a-visible-image-using-the-drag-functionality-e4546/CS/CustomImageEditor/Form1.cs#L27

gridControl1.RepositoryItems.Add(newCustomImageEditReposioryItem);
(gridControl1.MainView as GridView).CalcRowHeight += Form1_CalcRowHeight;
(gridControl1.MainView as GridView).Columns["InfoImage"].ColumnEdit = newCustomImageEditReposioryItem;

how-to-implement-the-rows-autoheight-feature-so-all-rows-fill-all-avaliable-space-e2781/CS/WindowsApplication1/WindowsApplication1/Form1.cs#L32

    gridControl1.DataSource = CreateTable(10);
    gridView1.CalcRowHeight += new RowHeightEventHandler(gridView1_CalcRowHeight);
}

VB.NET

pictureedit-how-to-choose-a-visible-image-using-the-drag-functionality-e4546/VB/CustomImageEditor/Form1.vb#L29

gridControl1.RepositoryItems.Add(newCustomImageEditReposioryItem)
AddHandler TryCast(gridControl1.MainView, GridView).CalcRowHeight, AddressOf Form1_CalcRowHeight
TryCast(gridControl1.MainView, GridView).Columns("InfoImage").ColumnEdit = newCustomImageEditReposioryItem

how-to-implement-the-rows-autoheight-feature-so-all-rows-fill-all-avaliable-space-e2781/VB/Form1.vb#L31

    gridControl1.DataSource = CreateTable(10)
    AddHandler gridView1.CalcRowHeight, AddressOf gridView1_CalcRowHeight
End Sub