ComponentOne Bitmap for WinForms
C1.Win.C1DX.4.8 Assembly / C1.Util.DX.DirectWrite Namespace / TextAnalysisSource Interface / GetTextAtPosition Method
The first position of the piece to obtain. All positions are in UTF16 code units, not whole characters, which matters when supplementary characters are used.

In This Topic
    GetTextAtPosition Method (TextAnalysisSource)
    In This Topic
    Gets a block of text starting at the specified text position.
    Syntax
    'Declaration
     
    Function GetTextAtPosition( _
       ByVal textPosition As System.Integer _
    ) As System.String
    System.string GetTextAtPosition( 
       System.int textPosition
    )

    Parameters

    textPosition
    The first position of the piece to obtain. All positions are in UTF16 code units, not whole characters, which matters when supplementary characters are used.

    Return Value

    a block of text
    Remarks
    Returning NULL indicates the end of text, which is the position after the last character. This function is called iteratively for each consecutive block, tying together several fragmented blocks in the backing store into a virtual contiguous string. Although applications can implement sparse textual content that maps only part of the backing store, the application must map any text that is in the range passed to any analysis functions.
    See Also