System.Windows.Forms.DataGridViewColumn.GetPreferredWidth Method

Calculates the ideal width of the column based on the specified criteria.

Syntax

public virtual int GetPreferredWidth (DataGridViewAutoSizeColumnMode autoSizeColumnMode, bool fixedHeight)

Parameters

autoSizeColumnMode
A System.Windows.Forms.DataGridViewAutoSizeColumnMode value that specifies an automatic sizing mode.
fixedHeight
true to calculate the width of the column based on the current row heights; false to calculate the width with the expectation that the row heights will be adjusted.

Returns

The ideal width, in pixels, of the column.

Remarks

This property is used by the content-based automatic sizing feature of the System.Windows.Forms.DataGridView control to determine the ideal width of a column.

A fixedHeight parameter value of false calculates the column width based on calculated row heights that will achieve ideal cell height-to-width ratios. For cell contents to wrap onto multiple lines, the cell style in effect for the cell must have a DataGridViewCellStyle.WrapMode property value of DataGridViewTriState.True.

For more information about automatic sizing, see Sizing Options in the Windows Forms DataGridView Control.

Requirements

Namespace: System.Windows.Forms
Assembly: System.Windows.Forms (in System.Windows.Forms.dll)
Assembly Versions: 2.0.0.0
Since: .NET 2.0