GetSelectedText Method

Summary

Selected text of a page or all pages in the document as a simple string object.

Syntax

C++

public string GetSelectedText( 
   int pageNumber 
)

Public Function GetSelectedText( 
   ByVal pageNumber As Integer 
) As String

public:  
   String^ GetSelectedText( 
      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 selected text of the page or the document as a simple string object, or an empty string if no selected text was found.

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

Leadtools.Document.Viewer Namespace

Download our FREE evaluation

Help Version 20.0.2020.4.3