Field_GetFont()

Examples


The Field_GetFont() function retrieves the font characteristics for a field.

Syntax

Field_GetFont(text_field, font, size, style)

Parameters

text_field – The field for which the font characteristics will be retrieved.

font – A returned integer corresponding to one of the following constants:

[spacer]

Constant

Description

FONT_COURIER

Courier

FONT_HELVETICA

Helvetica

FONT_TIMES

Times

FONT_SYSTEM

The default system font


size – A returned integer specifying the size of the font in points.

style – A returned integer corresponding to one of the following constants:

[spacer]

Constant

Description

FONT_STYLE_PLAIN

Plain

FONT_STYLE_BOLD

Bold

FONT_STYLE_ITALIC

Italic

FONT_STYLE_UNDERLINE

Underline


If several styles are applied to the field, the sum of the appropriate constants will be returned. For example, if the bold and underline styles are applied, a value corresponding to FONT_STYLE_BOLD + FONT_STYLE_UNDERLINE will be returned.

Return value

A boolean. True indicates the font characteristics were retrieved, while false indicates they were not.


Documentation Feedback