ImageGear v26.3 - Updated
ImageGear.Formats.Pdf Assembly / ImageGear.Formats.PDF Namespace / ImGearPDEText Class / GetAdvance Method
ImGearPDETextFlags 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:CHAR -- for a text characterRUN -- for a text runIn addition, set the 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 of the character or text run in the text.




In This Topic
    GetAdvance Method
    In This Topic
    Gets the advance width of a character or a text element.
    Syntax
    'Declaration
     
    Public Function GetAdvance( _
       ByVal options As ImGearPDETextFlags, _
       ByVal index As Integer _
    ) As ImGearPDFFixedPoint
    'Usage
     
    Dim instance As ImGearPDEText
    Dim options As ImGearPDETextFlags
    Dim index As Integer
    Dim value As ImGearPDFFixedPoint
     
    value = instance.GetAdvance(options, index)
    public ImGearPDFFixedPoint GetAdvance( 
       ImGearPDETextFlags options,
       int index
    )
    public: ImGearPDFFixedPoint* GetAdvance( 
       ImGearPDETextFlags options,
       int index
    ) 
    public:
    ImGearPDFFixedPoint^ GetAdvance( 
       ImGearPDETextFlags options,
       int index
    ) 

    Parameters

    options
    ImGearPDETextFlags 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:CHAR -- for a text characterRUN -- for a text runIn addition, set the 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

    ImGearPDFFixedPoint class object indicating the advance width.
    Remarks
    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.

    See Also