ImageGear v26.3 - Updated
ImageGear.Formats.Pdf Assembly / ImageGear.Formats.PDF Namespace / ImGearPDEText Class / Add Method / Add(ImGearPDETextFlags,Int32,String,ImGearPDEFont,ImGearPDEGraphicState,ImGearPDETextState,ImGearPDFFixedMatrix) Method
ImGearPDETextFlags options that specify what kind of text to add. Must be either:CHAR - for a text character, or RUN - for a text run.
Index after which to add character or text run.
String with Unicode characters to add.
Font for the element. Must be TrueType or Type 0 font.
The graphics state for the element.
The text state for the element.
The coordinates of text are specified in text space. TextMatrix defines the transformation from text space to the user space. See section '5.3.1 Text-Positioning Operators' of the PDF Reference for more details.




In This Topic
    Add(ImGearPDETextFlags,Int32,String,ImGearPDEFont,ImGearPDEGraphicState,ImGearPDETextState,ImGearPDFFixedMatrix) Method
    In This Topic
    Adds a Unicode character or a Unicode text run to a PDE Text object.
    Syntax
    'Declaration
     
    Public Overloads Sub Add( _
       ByVal options As ImGearPDETextFlags, _
       ByVal index As Integer, _
       ByVal text As String, _
       ByVal font As ImGearPDEFont, _
       ByVal graphicsState As ImGearPDEGraphicState, _
       ByVal textState As ImGearPDETextState, _
       ByVal textMatrix As ImGearPDFFixedMatrix _
    ) 
    'Usage
     
    Dim instance As ImGearPDEText
    Dim options As ImGearPDETextFlags
    Dim index As Integer
    Dim text As String
    Dim font As ImGearPDEFont
    Dim graphicsState As ImGearPDEGraphicState
    Dim textState As ImGearPDETextState
    Dim textMatrix As ImGearPDFFixedMatrix
     
    instance.Add(options, index, text, font, graphicsState, textState, textMatrix)

    Parameters

    options
    ImGearPDETextFlags options that specify what kind of text to add. Must be either:CHAR - for a text character, or RUN - for a text run.
    index
    Index after which to add character or text run.
    text
    String with Unicode characters to add.
    font
    Font for the element. Must be TrueType or Type 0 font.
    graphicsState
    The graphics state for the element.
    textState
    The text state for the element.
    textMatrix
    The coordinates of text are specified in text space. TextMatrix defines the transformation from text space to the user space. See section '5.3.1 Text-Positioning Operators' of the PDF Reference for more details.
    Remarks

    This method should be used for adding text encoded with Unicode.

    The Unicode API methods require a TrueType or Type 0 font that can be embedded. This font must be created from a font file on the local machine, because the lookup tables used by these API only exist in the font files. This is required even if you only check for representable text. This method will raise an exception, if used with other fonts, like Type 1 or font retrieved from an existing PDF document.

    Example
    See Also