This documentation is archived and is not being maintained.

DataGridColumnStyle.GetPreferredHeight Method

When overridden in a derived class, gets the height used for automatically resizing columns.

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

protected internal abstract int GetPreferredHeight(
	Graphics g,
	Object value
)

Parameters

g
Type: System.Drawing.Graphics
A Graphics object.
value
Type: System.Object
An object value for which you want to know the screen height and width.

Return Value

Type: System.Int32
The height used for auto resizing a cell.

The GetPreferredSize will usually be invoked from a mouse down event to resize a column's height for a long string.

The following code example uses the GetPreferredHeight method to return the height of a cell.


public class Form1: Form
{
 protected DataGrid dataGrid1;

private void GetHeight(){
    MyGridColumn myGridColumn;
    // Get a DataGridColumnStyle of a DataGrid control.
    myGridColumn = (MyGridColumn) dataGrid1.TableStyles[0].
    GridColumnStyles["CompanyName"];
    // Create a Graphics object.
    Graphics g = this.CreateGraphics();
    Console.WriteLine(myGridColumn.GetPrefHeight(g, "A string"));
 }
}

public class MyGridColumn:DataGridTextBoxColumn{
   public int GetPrefHeight(Graphics g, string thisString){
      return this.GetPreferredHeight(g,thisString);
   }
}


.NET Framework

Supported in: 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows XP SP2 x64 Edition, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

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