Export (0) Print
Expand All

DataGridTextBoxColumn.GetPreferredSize Method

This member overrides DataGridColumnStyle.GetPreferredSize(Graphics, Object), and more complete documentation might be available in that topic.

Returns the optimum width and height of the cell in a specified row relative to the specified value.

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

protected internal override Size GetPreferredSize(
	Graphics g,
	Object value
)

Parameters

g
Type: System.Drawing.Graphics

A Graphics object used to draw shapes on the screen.

value
Type: System.Object

The value to draw.

Return Value

Type: System.Drawing.Size
A Size that contains the dimensions of the cell.

The optimum width and height is calculated by measuring the string size, taking into account its font and attributes, and adding margin values.

The following example uses GetPreferredSize to return a Size.

public class Form1: Form
{
 protected DataGrid dataGrid1;

private void GetPreferredSize(){
   Graphics g;
   g = this.CreateGraphics();
   Size gridPreferredSize;
   MyGridColumn myTextColumn;
    // Assuming column 1 of a DataGrid control is a  
    // DataGridTextBoxColumn.
   myTextColumn = (MyGridColumn)
   dataGrid1.TableStyles[0].GridColumnStyles[1];
   string myVal;
   myVal = "A long string value";
   gridPreferredSize = myTextColumn.GetPrefSize(g, myVal);
   Console.WriteLine(gridPreferredSize);
   }
}

public class MyGridColumn:DataGridTextBoxColumn{
   public Size GetPrefSize(Graphics g, string val){
      return this.GetPreferredSize(g, val);
   }
}

.NET Framework

Supported in: 4.5.2, 4.5.1, 4.5, 4, 3.5, 3.0, 2.0, 1.1, 1.0

.NET Framework Client Profile

Supported in: 4, 3.5 SP1

Windows 8.1, Windows Server 2012 R2, Windows 8, Windows Server 2012, Windows 7, Windows Vista SP2, Windows Server 2008 (Server Core Role not supported), Windows Server 2008 R2 (Server Core Role supported with SP1 or later; Itanium not supported)

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

Show:
© 2014 Microsoft