DataGridViewCell.MeasureTextPreferredSize Method

Definition

Namespace:

System.Windows.Forms

Assembly:

System.Windows.Forms.dll

Source:

DataGridViewCell.cs

Gets the ideal height and width of the specified text given the specified characteristics.

public:
 static System::Drawing::Size MeasureTextPreferredSize(System::Drawing::Graphics ^ graphics, System::String ^ text, System::Drawing::Font ^ font, float maxRatio, System::Windows::Forms::TextFormatFlags flags);

public static System.Drawing.Size MeasureTextPreferredSize (System.Drawing.Graphics graphics, string? text, System.Drawing.Font font, float maxRatio, System.Windows.Forms.TextFormatFlags flags);

static member MeasureTextPreferredSize : System.Drawing.Graphics * string * System.Drawing.Font * single * System.Windows.Forms.TextFormatFlags -> System.Drawing.Size

Public Shared Function MeasureTextPreferredSize (graphics As Graphics, text As String, font As Font, maxRatio As Single, flags As TextFormatFlags) As Size

Parameters

graphics

Graphics

The Graphics used to render the text.

text

String

The text to measure.

font

Font

The Font applied to the text.

maxRatio

Single

The maximum width-to-height ratio of the block of text.

flags

TextFormatFlags

A bitwise combination of TextFormatFlags values to apply to the text.

Returns

Size

A Size representing the preferred height and width of the text.

Exceptions

ArgumentNullException

graphics is null.

-or-

font is null.

ArgumentOutOfRangeException

maxRatio is less than or equal to 0.

InvalidEnumArgumentException

flags is not a valid bitwise combination of TextFormatFlags values.

Remarks

If multiple lines are required and the specified formatting allows it, the size returned includes the combined height of all lines.

See also

• DataGridView