GetAdvance Method

Description:

Gets the advance width of a character or a text element. Advance width is returned in either character space or user space. The advance width is the amount by which the current point advances when the character is drawn.

Advance width may be horizontal or vertical, depending on the writing style. Thus the return value has both a horizontal and vertical component.

Syntax:

      GetAdvance (Flags As enumIGPDETextFlags, Index As Long) As
IGPDFFixedPoint

Parameters:

Name	Description
Flags	enumIGPDETextFlag value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. Must be either: IG_PDE_TEXT_CHAR - for a text character IG_PDE_TEXT_RUN - for a text run In addition, set the IG_PDE_TEXT_PAGE_SPACE flag to obtain the advance width in user space. If it is not set, the advance width is in character space. If this flag is not set, this method returns a value that is independent of any sizes, matrices, or scaling, simply adding up the font's raw glyph widths, supplemented only by unscaled character and word spacing.
Index	Index of the character or text run in the text.

Name

Description

Flags

enumIGPDETextFlag value that specifies whether index refers to the character offset from the beginning of the text object or the index of the text run in the text object. Must be either:

IG_PDE_TEXT_CHAR - for a text character
IG_PDE_TEXT_RUN - for a text run

In addition, set the IG_PDE_TEXT_PAGE_SPACE flag to obtain the advance width in user space. If it is not set, the advance width is in character space. If this flag is not set, this method returns a value that is independent of any sizes, matrices, or scaling, simply adding up the font's raw glyph widths, supplemented only by unscaled character and word spacing.

Index

Index of the character or text run in the text.

Return Value:

IGPDFFixedPoint Object indicating the advance width.