Export (0) Print
Expand All

DataGridViewRow.GetPreferredHeight Method

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)

public virtual int GetPreferredHeight (
	int rowIndex,
	DataGridViewAutoSizeRowMode autoSizeRowMode,
	bool fixedWidth
)
public int GetPreferredHeight (
	int rowIndex, 
	DataGridViewAutoSizeRowMode autoSizeRowMode, 
	boolean fixedWidth
)
public function GetPreferredHeight (
	rowIndex : int, 
	autoSizeRowMode : DataGridViewAutoSizeRowMode, 
	fixedWidth : boolean
) : int
Not applicable.

Parameters

rowIndex

The index of the row whose preferred height is calculated.

autoSizeRowMode

A DataGridViewAutoSizeRowMode that specifies an automatic sizing mode.

fixedWidth

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

Return Value

The ideal height of the row, in pixels.

Exception typeCondition

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.

// Adjusts the padding when the user changes the row height so that 
// the normal cell content is fully displayed and any extra
// height is used for the content that spans multiple columns.
void dataGridView1_RowHeightChanged(object sender,
    DataGridViewRowEventArgs e)
{
    // Calculate the new height of the normal cell content.
    Int32 preferredNormalContentHeight =
        e.Row.GetPreferredHeight(e.Row.Index, 
        DataGridViewAutoSizeRowMode.AllCellsExceptHeader, true) -
        e.Row.DefaultCellStyle.Padding.Bottom;

    // Specify a new padding.
    Padding newPadding = e.Row.DefaultCellStyle.Padding;
    newPadding.Bottom = e.Row.Height - preferredNormalContentHeight;
    e.Row.DefaultCellStyle.Padding = newPadding;
}

Windows 98, Windows Server 2000 SP4, Windows CE, Windows Millennium Edition, Windows Mobile for Pocket PC, Windows Mobile for Smartphone, Windows Server 2003, Windows XP Media Center Edition, Windows XP Professional x64 Edition, Windows XP SP2, Windows XP Starter Edition

The Microsoft .NET Framework 3.0 is supported on Windows Vista, Microsoft Windows XP SP2, and Windows Server 2003 SP1.

.NET Framework

Supported in: 3.0, 2.0

Community Additions

ADD
Show:
© 2014 Microsoft