GetPreferredHeight Method

DataGridViewRow.GetPreferredHeight Method (Int32, DataGridViewAutoSizeRowMode, Boolean)

 

Calculates the ideal height of the specified row based on the specified criteria.

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

abstract GetPreferredHeight : 
        rowIndex:int *
        autoSizeRowMode:DataGridViewAutoSizeRowMode *
        fixedWidth:bool -> int
override GetPreferredHeight : 
        rowIndex:int *
        autoSizeRowMode:DataGridViewAutoSizeRowMode *
        fixedWidth:bool -> int

Parameters

rowIndex
Type: System.Int32

The index of the row whose preferred height is calculated.

autoSizeRowMode
Type: System.Windows.Forms.DataGridViewAutoSizeRowMode

A DataGridViewAutoSizeRowMode that specifies an automatic sizing mode.

fixedWidth
Type: System.Boolean

true to calculate the preferred height for a fixed cell width; otherwise, false.

Return Value

Type: System.Int32

The ideal height of the row, in pixels.

Exception Condition
InvalidEnumArgumentException

autoSizeRowMode is not a valid DataGridViewAutoSizeRowMode value.

ArgumentOutOfRangeException

The rowIndex is not in the valid range of 0 to the number of rows in the control minus 1.

This property is used by the content-based automatic sizing feature of the DataGridView control to determine the ideal height of a row. The rowIndex value lets you specify the actual row index of a shared row. (Shared rows have Index property values of -1.)

A fixedWidth parameter value of false calculates the row height based on calculated column widths 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.

The following code example uses the GetPreferredHeight method to determine the new padding for a row that has been resized. This code example is part of a larger example provided in How to: Customize the Appearance of Rows in the Windows Forms DataGridView Control.

No code example is currently available or this language may not be supported.

.NET Framework
Available since 2.0
Return to top
Show:
© 2016 Microsoft