GridView.BestFitColumns() Method

Adjusts column widths so that columns fit their content in an optimal way.

Namespace: DevExpress.XtraGrid.Views.Grid

Assembly: DevExpress.XtraGrid.v24.2.dll

Declaration

C#

public virtual void BestFitColumns()

VB.NET

Public Overridable Sub BestFitColumns

Remarks

Call the BestFitColumns method to resize columns to the minimum width required to accommodate the content of the following elements:

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

Note

Call the GridControl.ForceInitialize method first to invoke the best fit functionality in the form’s Load event handler.

Specific Notes

• If the GridOptionsView.ColumnAutoWidth property is enabled, the BestFitColumns method resizes columns to fit their content within the View’s width. Cell content may still be truncated.

• The BestFitColumns method retains a column’s width if the column’s OptionsColumn.FixedWidth option is enabled or the OptionsColumn.AllowSize property is disabled.

• A BestFitColumns method call has no effect if the GridOptionsCustomization.AllowColumnResizing option is disabled.

Example

The following code snippet updates column widths when users change cell values:

C#

private void GridView1_CellValueChanged(object sender, CellValueChangedEventArgs e) {
  gridView1.BestFitColumns();
}

VB.NET

Private Sub GridView1_CellValueChanged(ByVal sender As Object, ByVal e As CellValueChangedEventArgs)
  gridView1.BestFitColumns()
End Sub

Related Settings

API	Description
GridOptionsView.BestFitMaxRowCount	Gets or sets the number of data rows to process for optimal width calculation.
GridOptionsView.BestFitUseErrorInfo	Gets or sets whether cell error icons are taken into account when calculating the “best width” for columns.
GridOptionsView.BestFitMode	Gets or sets whether column best-fit resizing operations should prioritize precision or speed.

Related GitHub Examples

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

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/CS/ScheduledTasksAPIClientDemo/MainForm.cs#L43

    scheduledJobsGrid.DataSource = scheduledJobs;
    scheduledJobsView.BestFitColumns();
}

winforms-grid-bind-to-azure-sql-database/CS/DXApplication1/Main.cs#L14

gridControl.DataSource = await DataTableProvider.Instance.GetDataAsync();
gridView.BestFitColumns();
gridView.LoadingPanelVisible = false;

winforms-grid-custom-button-caption-customrowcelledit-event/CS/WindowsApplication1/Form1.cs#L22

    gridControl1.DataSource = CreateTable(20);
    gridView1.BestFitColumns();
}

winforms-grid-split-presentation/CS/Form1.cs#L37

// Resize columns according to their values.
view.BestFitColumns();
// Locate a row containing a specific value.

winforms-grid-data-annotation-attributes/CS/GridDataAttributes/Form1.cs#L23

    gridControl1.MainView.PopulateColumns();
    (gridControl1.MainView as GridView).BestFitColumns();
}

VB.NET

report-server-how-to-manage-scheduled-jobs-from-a-windows-forms-application/VB/ScheduledTasksAPIClientDemo/MainForm.vb#L43

    scheduledJobsGrid.DataSource = scheduledJobs
    scheduledJobsView.BestFitColumns()
End Sub

winforms-grid-bind-to-azure-sql-database/VB/DXApplication1/Main.vb#L16

gridControl.DataSource = Await DataTableProvider.Instance.GetDataAsync()
gridView.BestFitColumns()
gridView.LoadingPanelVisible = False

winforms-grid-custom-button-caption-customrowcelledit-event/VB/WindowsApplication1/Form1.vb#L28

    gridControl1.DataSource = CreateTable(20)
    gridView1.BestFitColumns()
End Sub

winforms-grid-split-presentation/VB/Form1.vb#L39

' Resize columns according to their values.
view.BestFitColumns()
' Locate a row containing a specific value.

winforms-grid-data-annotation-attributes/VB/GridDataAttributes/Form1.vb#L20

    gridControl1.MainView.PopulateColumns()
    TryCast(gridControl1.MainView, GridView).BestFitColumns()
End Sub