This documentation is for the old version. Go to the latest Graphics Mill docs

Font.GetBlackBox Method (String, Single[])

Returns a rectangle that describes the string black box.

Namespace: Aurigma.GraphicsMill.Drawing
Assembly: Aurigma.GraphicsMill (in Aurigma.GraphicsMill.dll)

Syntax

Visual Basic 
Public Function GetBlackBox ( _
	string As String, _
	kernings As Single() _
) As RectangleF
C# 
public RectangleF GetBlackBox(
	string string,
	float[] kernings
)

Parameters

string

Type: System.String

String to retrieve black box for.
kernings

Type: System.Single []

Array of kerning modifiers. The first entry of this array specify additional distance (may be negative) between first and second character of the string; the second entry specifies additional distance between second and third character, etc.

Return Value

The rectangle that describes the string black box.

Remarks

String black box is a tightest bounding rectangle of glyphs in cells of all characters in a string. This way you can calculate actual height of the character without any leading whitespaces.

See Also

Reference