GetDocumentPageText Method

public DocumentPageText GetDocumentPageText( 
   int pageNumber
)

'Declaration
 

Public Function GetDocumentPageText( _
   ByVal pageNumber As Integer _
) As DocumentPageText

'Usage
 

Dim instance As DocumentViewerText
Dim pageNumber As Integer
Dim value As DocumentPageText
 
value = instance.GetDocumentPageText(pageNumber)

public:
DocumentPageText^ GetDocumentPageText( 
   int pageNumber
) 

Parameters

pageNumber

Pager number to use. This cannot be 0.

Return Value

DocumentViewerText saves the DocumentPageText items internally when they are obtained. Hence, this method will first check if the value has already been obtained, if so, it will return the cached item. Otherwise, DocumentPage.GetText will be called and the result is stored internally before it is returned.

Calling DocumentPage.GetText might be a slow operation especially if text parsing involves OCR. Therefore, this method will fire the Operation event with DocumentViewerOperation.GetText. The application can intercept this event and show a busy dialog if required.

Refer to AutoGetText for more information.

Target Platforms

Reference

DocumentViewerText Class
DocumentViewerText Members