CustomBestFitEventArgsBase.BestFitRows Property

Rows that should be taken into account when calculating the optimal width of CustomBestFitEventArgs.Column.

Namespace: DevExpress.Xpf.Grid

Assembly: DevExpress.Xpf.Grid.v18.2.Core.dll

Declaration

C#

public IEnumerable<int> BestFitRows { get; set; }

VB.NET

Public Property BestFitRows As IEnumerable(Of Integer)

Property Value

Type	Description
IEnumerable<Int32>	An array of row handles that correspond to data rows.

Remarks

The BestFitRows property allows you to specify the exact cells in the processed column to be used to calculate its optimal width. Set the BestFitRows property to a collection of row handles. The column’s optimal width will be calculated according to the content of data cells that correspond to the processed column and the specified rows.

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

Example

This example shows how to specify rows that should be taken into account when calculating the optimal width of a column. Specify required rows by selecting their handles in the list box, invoke the Best Fit method by right-clicking the column's header and choosing the correspondent menu item.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/an-example-of-using-the-custombestfit-event-e3757.

MainWindow.xaml.vb

Imports Microsoft.VisualBasic
Imports System
Imports System.Collections.Generic
Imports System.Windows
Imports System.Windows.Controls

Namespace WpfApplication5
    ''' <summary>
    ''' Interaction logic for MainWindow.xaml
    ''' </summary>
    Partial Public Class MainWindow
        Inherits Window
        Public Sub New()
            InitializeComponent()
            Dim source() As String = { "123456789", "1234567890", "12345678901", "123456789012" }
            gridControl1.ItemsSource = source

        End Sub
        Private Sub tableView1_CustomBestFit(ByVal sender As Object, ByVal e As DevExpress.Xpf.Grid.CustomBestFitEventArgs)
            Dim selectedRows As New LinkedList(Of Integer)()
            For Each item As ListBoxItem In listBoxEdit1.SelectedItems
                If item.IsEnabled Then
                    selectedRows.AddLast(Convert.ToInt32(item.Content))
                End If
            Next item
            e.BestFitRows = selectedRows
        End Sub
    End Class
End Namespace

MainWindow.xaml

<Window x:Class="WpfApplication5.MainWindow"
        xmlns="http://schemas.microsoft.com/winfx/2006/xaml/presentation"
        xmlns:x="http://schemas.microsoft.com/winfx/2006/xaml"
        xmlns:dxlc="http://schemas.microsoft.com/netfx/2007/xaml/presentation"
        xmlns:dx="http://schemas.devexpress.com/winfx/2008/xaml/core"
        dx:ThemeManager.ThemeName="Office2010Black"
        Title="MainWindow" Height="300" Width="350" xmlns:dxg="http://schemas.devexpress.com/winfx/2008/xaml/grid" xmlns:dxe="http://schemas.devexpress.com/winfx/2008/xaml/editors">
    <Grid>
        <dxlc:GroupBox Name="groupBox1" Padding="5">
            <Grid>
                <Grid.ColumnDefinitions>
                    <ColumnDefinition/>
                    <ColumnDefinition Width="100"/>
                </Grid.ColumnDefinitions>
                <Grid.RowDefinitions>
                    <RowDefinition Height="30"/>
                    <RowDefinition/>
                </Grid.RowDefinitions>
                <Label Content="Grid:" VerticalAlignment="Center" Grid.Row="0" Grid.Column="0"></Label>
                <Label Content="Row handles:" VerticalAlignment="Center" Grid.Row="0" Grid.Column="1"></Label>
                <dxg:GridControl Grid.Column="0" Grid.Row="1" Name="gridControl1" AutoPopulateColumns="True">
                    <dxg:GridControl.View>
                        <dxg:TableView Name="tableView1" CustomBestFit="tableView1_CustomBestFit">
                        </dxg:TableView>
                    </dxg:GridControl.View>
                </dxg:GridControl>
                <dxe:ListBoxEdit Grid.Column="1" Grid.Row="1" Name="listBoxEdit1">
                    <dxe:ListBoxEdit.StyleSettings>
                        <dxe:CheckedListBoxEditStyleSettings />
                    </dxe:ListBoxEdit.StyleSettings>
                    <dxe:ListBoxEditItem Content="0" />
                    <dxe:ListBoxEditItem Content="1" />
                    <dxe:ListBoxEditItem Content="2" />
                    <dxe:ListBoxEditItem Content="3" />
                </dxe:ListBoxEdit>
         </Grid>
        </dxlc:GroupBox>
    </Grid>
</Window>

MainWindow.xaml.cs

using System;
using System.Collections.Generic;
using System.Windows;
using System.Windows.Controls;

namespace WpfApplication5
{
    /// <summary>
    /// Interaction logic for MainWindow.xaml
    /// </summary>
    public partial class MainWindow : Window
    {
        public MainWindow()
        {
            InitializeComponent();
            string[] source = new string[] { "123456789", "1234567890", "12345678901", "123456789012" };
            gridControl1.ItemsSource = source;

        }
        private void tableView1_CustomBestFit(object sender, DevExpress.Xpf.Grid.CustomBestFitEventArgs e)
        {
            LinkedList<int> selectedRows = new LinkedList<int>();
            foreach (ListBoxItem item in listBoxEdit1.SelectedItems)
                if (item.IsEnabled)
                    selectedRows.AddLast(Convert.ToInt32(item.Content));
            e.BestFitRows = selectedRows;
        }
    }
}

Related GitHub Examples

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

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

            selectedRows.AddLast(Convert.ToInt32(item.Content));
    e.BestFitRows = selectedRows;
}

VB.NET

an-example-of-using-the-custombestfit-event-e3757/VB/MainWindow.xaml.vb#L26

    Next item
    e.BestFitRows = selectedRows
End Sub