←Select platform

TextExtractionMode Property (DocumentText)

Summary

Mode to use when extracting text from this document.

Syntax

Java

C++

public DocumentTextExtractionMode TextExtractionMode { get; set; }

Public Property TextExtractionMode() As DocumentTextExtractionMode 
   Get 
   Set

public:  
   property DocumentTextExtractionMode^ TextExtractionMode 
   { 
      DocumentTextExtractionMode^ get() 
      void set(DocumentTextExtractionMode^ value) 
   }

public DocumentTextExtractionMode getTextExtractionMode() 
public void setTextExtractionMode(DocumentTextExtractionMode value)

Property Value

The mode to use when extracting text from this document. Default value is DocumentTextExtractionMode.Auto.

Remarks

TextExtractionMode is used to control how DocumentPage.GetText extracts the text from the page.

If the value of TextExtractionMode is DocumentTextExtractionMode.Auto or DocumentTextExtractionMode.OcrOnly then an OCR engine instance is required in order to extract the text correctly. This instance must be set in the OcrEngine property prior to calling DocumentPage.GetText.

DocumentImages.IsSvgSupported is used to determine whether the document supports extracting text using SVG.

For more information, refer to Parsing Text with the Documents Library.

Note that setting this property to a value will update the same value in each child document.

Example

For an example, refer to DocumentText.AutoParseLinks.

Requirements

Target Platforms

See Also

Reference

DocumentText Class

DocumentText Members

Leadtools.Documents Namespace