ArcGIS Pro 3.8 API Reference Guide
ArcGIS.Core.OCR Namespace / OCRManager Class / IsValidDocumentForOCR Method
The document file on disk.
Example

In This Topic
    IsValidDocumentForOCR Method
    In This Topic
    Gets if the specified document is suitable for Optical Character Recognittion (OCR) in order to extract text.
    Syntax
    public bool IsValidDocumentForOCR( 
       string documentFileName
    )
    Public Function IsValidDocumentForOCR( _
       ByVal documentFileName As String _
    ) As Boolean

    Parameters

    documentFileName
    The document file on disk.

    Return Value

    True if the file is supported for OCR; false otherwise.
    Remarks
    The following file extensions are supported - pdf, tif, tiff, jpg, jpeg, png and bmp.
    Example
    Determine if a document is valid for OCR
    {
      string docFileName1 = "c:\\MyData\\MyDocument.pdf";
      string docFileName2 = "c:\\MyData\\MyDocument.bmp";
      string docFileName3 = "c:\\MyData\\MyDocument.txt";
    
      var isValid = OCRManager.Instance.IsValidDocumentForOCR(docFileName1);
      // isValid = true
    
      isValid = OCRManager.Instance.IsValidDocumentForOCR(docFileName2);
      // isValid = true
    
      isValid = OCRManager.Instance.IsValidDocumentForOCR(docFileName3);
      // isValid = false
    }
    Requirements

    Target Platforms: Windows 11 Home, Pro, Enterprise (64 bit)

    ArcGIS Pro version: 3.8 or higher.
    See Also