DataGridColumnStyle::GetPreferredSize Method (Graphics^, Object^)

 

When overridden in a derived class, gets the width and height of the specified value. The width and height are used when the user navigates to DataGridTableStyle using the DataGridColumnStyle.

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

public protected:
virtual Size GetPreferredSize(
	Graphics^ g,
	Object^ value
) abstract

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.Drawing::Size

A Size that contains the dimensions of the cell.

Use GetPreferredSize to determine the width a column should resize to, given a particular string or numeral.

The following code example uses the GetPreferredSize method to return the optimum size for a value.

public ref class MyGridColumn: public DataGridTextBoxColumn
{
public:
   Size GetPrefSize( Graphics^ g, String^ thisString )
   {
      return this->GetPreferredSize( g, thisString );
   }

};

public ref class Form1: public Form
{
protected:
   DataGrid^ dataGrid1;

private:
   void GetHeight()
   {
      MyGridColumn^ myGridColumn;

      // Get a DataGridColumnStyle of a DataGrid control.
      myGridColumn = dynamic_cast<MyGridColumn^>(dataGrid1->TableStyles[ 0 ]->GridColumnStyles[ "CompanyName" ]);

      // Create a Graphics object.
      Graphics^ g = this->CreateGraphics();
      System::Drawing::Size s = myGridColumn->GetPrefSize( g, "A string" );
   }

};

.NET Framework
Available since 1.1
Return to top
Show: