FontFamily.GetCellAscent(FontStyle) Method

Definition

Namespace:

System.Drawing

Assembly:

System.Drawing.Common.dll

Package:

System.Drawing.Common v8.0.0

Source:

FontFamily.cs

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

public:
 int GetCellAscent(System::Drawing::FontStyle style);

public int GetCellAscent (System.Drawing.FontStyle style);

member this.GetCellAscent : System.Drawing.FontStyle -> int

Public Function GetCellAscent (style As FontStyle) As Integer

Parameters

style

FontStyle

A FontStyle that contains style information for the font.

Returns

Int32

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

Examples

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 = gcnew 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( String::Format( "ascentFontFamily.GetCellAscent() returns {0}.", cellAscent ),
            gcnew System::Drawing::Font( ascentFontFamily,16 ), Brushes::Black, PointF(0,0) );
   }

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));
}

Public Sub GetCellAscent_Example(ByVal e As PaintEventArgs)

    ' Create a FontFamily object.
    Dim ascentFontFamily As New FontFamily("arial")

    ' Get the cell ascent of the font family in design units.
    Dim cellAscent As Integer = _
    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))
End Sub

See also

• How To: Obtain Font Metrics