DataGridViewColumn.GetPreferredWidth Method (System.Windows.Forms)

GetPreferredWidth Method

Switch on low bandwidth view

Collapse All

Language Filter

This page is specific to

Microsoft Visual Studio 2008/.NET Framework 3.5

Other versions are also available for the following:

.NET Framework Class Library

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)

Syntax

Visual Basic (Declaration)

Public Overridable Function GetPreferredWidth ( _
    autoSizeColumnMode As DataGridViewAutoSizeColumnMode, _
    fixedHeight As Boolean _
) As Integer

Visual Basic (Usage)

Dim instance As DataGridViewColumn
Dim autoSizeColumnMode As DataGridViewAutoSizeColumnMode
Dim fixedHeight As Boolean
Dim returnValue As Integer

returnValue = instance.GetPreferredWidth(autoSizeColumnMode, _
    fixedHeight)

public virtual int GetPreferredWidth(
    DataGridViewAutoSizeColumnMode autoSizeColumnMode,
    bool fixedHeight
)

Visual C++

public:
virtual int GetPreferredWidth(
    DataGridViewAutoSizeColumnMode autoSizeColumnMode, 
    bool fixedHeight
)

JScript

public function GetPreferredWidth(
    autoSizeColumnMode : DataGridViewAutoSizeColumnMode, 
    fixedHeight : boolean
) : int

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.

Exceptions

Exception	Condition
ArgumentException	autoSizeColumnMode is NotSet, None, or Fill.
InvalidEnumArgumentException	autoSizeColumnMode is not a valid DataGridViewAutoSizeColumnMode value.

Remarks

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.

Platforms

Windows 7, Windows Vista, Windows XP SP2, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP Starter Edition, Windows Server 2008 R2, Windows Server 2008, Windows Server 2003, Windows Server 2000 SP4, Windows Millennium Edition, Windows 98

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

Version Information

.NET Framework

Supported in: 3.5, 3.0, 2.0

Reference

DataGridViewColumn Class

DataGridViewColumn Members

System.Windows.Forms Namespace

DataGridView

DataGridViewAutoSizeColumnMode

GetPreferredHeight

WrapMode