TableView.CustomBestFit Event

Enables you to manually calculate the optimal width for a column(s).

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v19.1.dll

Declaration

C#

public event CustomBestFitEventHandler CustomBestFit

VB.NET

Public Event CustomBestFit As CustomBestFitEventHandler

Event Data

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

Property	Description
BestFitMode	Gets or sets how the optimal width required for a column to completely display its contents is calculated. This is a dependency property. Inherited from CustomBestFitEventArgsBase.
BestFitRows	Rows that should be taken into account when calculating the optimal width of CustomBestFitEventArgs.Column. Inherited from CustomBestFitEventArgsBase.
Column	Provides access to a grid column whose width should be adjusted.
Handled	Gets or sets a value that indicates the present state of the event handling for a routed event as it travels the route. Inherited from RoutedEventArgs.
OriginalSource	Gets the original reporting source as determined by pure hit testing, before any possible Source adjustment by a parent class. Inherited from RoutedEventArgs.
RoutedEvent	Gets or sets the RoutedEvent associated with this RoutedEventArgs instance. Inherited from RoutedEventArgs.
Source	Gets the View that raised the event.

The event data class exposes the following methods:

Method	Description
InvokeEventHandler(Delegate, Object)	When overridden in a derived class, provides a way to invoke event handlers in a type-specific way, which can increase efficiency over the base implementation. Inherited from RoutedEventArgs.
OnSetSource(Object)	When overridden in a derived class, provides a notification callback entry point whenever the value of the Source property of an instance changes. Inherited from RoutedEventArgs.

Remarks

The CustomBestFit event is raised before the Best Fit feature is applied to a column, allowing you to manually calculate the optimal width for a column. When handling this event, you can do the following:

• Change the Best Fit Mode

  The CustomBestFit event is fired if the ColumnBase.BestFitMode property is set to BestFitMode.Smart. By default, the column’s optimal width is calculated as BestFitMode.AllRows if the total number of cells is less than 3,000, and as BestFitMode.DistinctValues if the total number of cells is greater than or equal to 3,000. Use the event parameter’s CustomBestFitEventArgsBase.BestFitMode property to select the required mode.

• Manually Specify Rows

  Populate the CustomBestFitEventArgsBase.BestFitRows collection with rows that should be taken into account when calculating the optimal width of CustomBestFitEventArgs.Column.

To learn more, see Best Fit in Columns Layout and Width.

Related GitHub Examples

The following code snippet (auto-collected from DevExpress Examples) contains a reference to the CustomBestFit 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#

an-example-of-using-the-custombestfit-event-e3757/CS/MainWindow.xaml#L23

<dxg:GridControl.View>
    <dxg:TableView Name="tableView1" CustomBestFit="tableView1_CustomBestFit">
    </dxg:TableView>