GridColumn.BestFit() Method

Resizes the column to the minimum width required to display the column content completely.

Namespace: DevExpress.XtraGrid.Columns

Assembly: DevExpress.XtraGrid.v19.2.dll

Declaration

C#

public virtual void BestFit()

VB.NET

Public Overridable Sub BestFit

Remarks

The BestFit method calculates the minimum width that is required to accommodate the content of the following elements:

• column header;
• summary footer cell;
• data cells;
• error icons in data cells (based on the GridOptionsView.BestFitUseErrorInfo property).

Note that the number of processed data cells depends upon the GridOptionsView.BestFitMaxRowCount property value. If set to -1, all data cells are processed. If set to a positive integer, the property specifies the number of cells to be processed. Cells are processed starting from the top visible row.

When the auto width feature is applied to the view, the column element content may not be displayed completely after BestFit. The reason is that total column width always matches the View width - while columns have a minimum allowed width and may have a fixed width. The auto width feature can be enabled/disabled using the GridOptionsView.ColumnAutoWidth option. Refer to the GridColumn.MinWidth property and OptionsColumn.FixedWidth option for details on column width restrictions. Note that band width restrictions also affect the BestFit functionality. Refer to the OptionsBand.FixedWidth and GridBand.MinWidth members for details.

Also note that calculated column width cannot exceed the current View width. Finally, the BestFit method cannot resize columns to widths less than that specified by the GridColumn.MinWidth property.

Your users can also apply best fit to columns. They need to double-click the desired column’s right edge or choose the Best Fit item from the column header’s context menu. The column’s OptionsColumn.FixedWidth option must be disabled and the OptionsColumn.AllowSize option must be enabled to activate this functionality.

The BestFit method is not supported in CardView.

The code sample below illustrates how to change the column width when a user changes a cell value.

C#

using DevExpress.XtraGrid;
using DevExpress.XtraGrid.Views.Grid;

..

gridView1.CellValueChanged += GridView1_CellValueChanged1;

private void GridView1_CellValueChanged1(object sender, DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs e)
{
    GridView view = sender as GridView;
    e.Column.BestFit();

}

VB.NET

Imports DevExpress.XtraGrid
Imports DevExpress.XtraGrid.Views.Grid

..

Private gridView1.CellValueChanged += AddressOf GridView1_CellValueChanged1

Private Sub GridView1_CellValueChanged1(ByVal sender As Object, ByVal e As DevExpress.XtraGrid.Views.Base.CellValueChangedEventArgs)
    Dim view As GridView = TryCast(sender, GridView)
    e.Column.BestFit()

End Sub

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the BestFit() method.

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#

capability-for-a-single-column-to-fill-an-empty-space-in-a-grid-view-e2436/CS/FillEmptySpaceGridColumn/FillGridColumn.cs#L33

{
    this.BestFit();
}

VB.NET

capability-for-a-single-column-to-fill-an-empty-space-in-a-grid-view-e2436/VB/FillEmptySpaceGridColumn/FillGridColumn.vb#L30

Else
    Me.BestFit()
End If