LOGFONT module

class LOGFONT.LOGFONT

Bases: SpireObject

Represents a logical font structure that defines the attributes of a font.

This class encapsulates the properties of a font, including its height, width, weight, orientation, and other characteristics. It is used to specify the visual attributes of text in Excel worksheets and charts.

lfCharSet() → int

Gets the character set of the font.

Returns:: The character set identifier.
Return type:: int

lfClipPrecision() → int

Gets the clipping precision for the font.

The clipping precision defines how to clip characters that are partially outside the clipping region.

Returns:: The clipping precision value.
Return type:: int

lfEscapement() → int

Gets the angle, in tenths of degrees, between the baseline of a font and the x-axis.

Returns:: The angle of escapement for the font.
Return type:: int

lfFaceName() → str

Gets the typeface name of the font.

Returns:: The typeface name of the font.
Return type:: str

lfHeight() → int

Gets the height of the font in logical units.

A positive value specifies the cell height of the font. A negative value specifies the character height of the font.

Returns:: The height of the font.
Return type:: int

lfItalic() → int

Gets a value indicating whether the font is italic.

Returns:: Nonzero if the font is italic; otherwise, 0.
Return type:: int

lfOrientation() → int

Gets the angle, in tenths of degrees, between each character’s baseline and the x-axis.

Returns:: The orientation angle of the font.
Return type:: int

lfOutPrecision() → int

Gets the output precision for the font.

The output precision defines how closely the output must match the requested font’s height, width, character orientation, escapement, pitch, and font type.

Returns:: The output precision value.
Return type:: int

lfPitchAndFamily() → int

Gets the pitch and family of the font.

The low-order bit specifies the pitch of the font, and the high-order bit specifies the font family.

Returns:: The pitch and family value.
Return type:: int

lfQuality() → int

Gets the output quality for the font.

The output quality defines how carefully the graphics device interface (GDI) must draw the output to match the characteristics of the selected font.

Returns:: The output quality value.
Return type:: int

lfStrikeOut() → int

Gets a value indicating whether the font has a strikeout.

Returns:: Nonzero if the font has a strikeout; otherwise, 0.
Return type:: int

lfUnderline() → int

Gets a value indicating whether the font is underlined.

Returns:: Nonzero if the font is underlined; otherwise, 0.
Return type:: int

lfWeight() → int

Gets the weight of the font in the range 0 through 1000.

Common values are: - 400: Normal - 700: Bold

Returns:: The weight of the font.
Return type:: int

lfWidth() → int

Gets the average width of characters in the font.

Returns:: The average width of characters in the font.
Return type:: int