Export (0) Print
Expand All

DataGridViewColumn.GetPreferredWidth Method

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

Namespace:  System.Windows.Forms
Assembly:  System.Windows.Forms (in System.Windows.Forms.dll)

public virtual int GetPreferredWidth(
	DataGridViewAutoSizeColumnMode autoSizeColumnMode,
	bool fixedHeight
)

Parameters

autoSizeColumnMode
Type: System.Windows.Forms.DataGridViewAutoSizeColumnMode

A DataGridViewAutoSizeColumnMode value that specifies an automatic sizing mode.

fixedHeight
Type: System.Boolean

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.

Return Value

Type: System.Int32
The ideal width, in pixels, of the column.

ExceptionCondition
ArgumentException

autoSizeColumnMode is NotSet, None, or Fill.

InvalidEnumArgumentException

autoSizeColumnMode is not a valid DataGridViewAutoSizeColumnMode value.

This property is used by the content-based automatic sizing feature of the 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 WrapMode property value of True.

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

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

The .NET Framework does not support all versions of every platform. For a list of the supported versions, see .NET Framework System Requirements.

Show:
© 2014 Microsoft