Export (0) Print
Expand All

FontFamily.GetCellAscent Method

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 PaintEventArgs e, 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

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