FontFamily.GetCellAscent Method (FontStyle)

 
System_CAPS_noteNote

The .NET API Reference documentation has a new home. Visit the .NET API Browser on docs.microsoft.com to see the new experience.

Returns the cell ascent, in design units, of the FontFamily of the specified style.

Namespace:   System.Drawing
Assembly:  System.Drawing (in System.Drawing.dll)

public int GetCellAscent(
	FontStyle style
)

Parameters

style
Type: System.Drawing.FontStyle

A FontStyle that contains style information for the font.

Return Value

Type: System.Int32

The cell ascent for this FontFamily that uses the specified FontStyle.

The following code example is designed for use with Windows Forms, and it requires PaintEventArgse, which is a parameter of the Paint event handler. The code performs the following actions:

  • Creates a FontFamily.

  • Gets the cell ascent for that font family.

  • Draws the value of the cell ascent to the screen as text.

public void GetCellAscent_Example(PaintEventArgs e)
{
    // Create a FontFamily object.
    FontFamily ascentFontFamily = new FontFamily("arial");

    // Get the cell ascent of the font family in design units.
    int cellAscent = ascentFontFamily.GetCellAscent(FontStyle.Regular);

    // Draw the result as a string to the screen.
    e.Graphics.DrawString(
        "ascentFontFamily.GetCellAscent() returns " + cellAscent.ToString() + ".",
        new Font(ascentFontFamily, 16),
        Brushes.Black,
        new PointF(0, 0));
}

.NET Framework
Available since 1.1
Return to top
Show: