ExportText Method

Text of a page or the whole document as a simple string object.

Syntax

C#
Visual Basic
Objective-C
Java
C++

public string ExportText( 
   int pageNumber
)

'Declaration

Public Function ExportText( _
   ByVal pageNumber As Integer _
) As String

'Usage

Dim instance As DocumentViewerText
Dim pageNumber As Integer
Dim value As String
 
value = instance.ExportText(pageNumber)

public:
String^ ExportText( 
   int pageNumber
)

Parameters

pageNumber: Page number to use. If this value is 0, then the text of all pages in the document will be used.

Return Value

The text of the page or the document as a simple string object.

Remarks

If the text of the specified page(s) was not previously obtained, then the value of AutoGetText will be used to determine whether DocumentPage.GetText is called automatically. Therefore, this method might experience a delay while the text is parsed from the document in this mode.

Example

For an example, refer to DocumentViewerText.

Requirements

Target Platforms

Reference

DocumentViewerText Class
DocumentViewerText Members