DataGridViewColumn.GetPreferredWidth Method (DataGridViewAutoSizeColumnMode, Boolean)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

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.

Exception Condition
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
Available since 2.0
Return to top
Show: