GdPictureImaging.SaveAsPDFOCRStream Method (Integer, Stream, TesseractDictionary, String, String, String, String, String, String, String, PdfEncryption, PdfRight, String, String)

Saves a GdPicture image as single page searchable PDF stream with encryption and performs an OCR recognition.

The recognized text is written invisibly to the PDF in order to simplify indexing and search.

For each language of recognition, you have to deploy specific files. See the Dictionary parameter.

public String SaveAsPDFOCRStream(
    int ImageID, 
    ref Stream PDFStream, 
    TesseractDictionary Dictionary, 
    String DictionaryPath, 
    String CharWhiteList, 
    String Title, 
    String Author, 
    String Subject, 
    String Keywords, 
    String Creator, 
    PdfEncryption Encryption, 
    PdfRight Rights, 
    String UserPassword, 
    String OwnerPassword
);

Visual Basic

Public Function SaveAsPDFOCRStream(
    ByVal ImageID As Integer, 
    ByRef PDFStream As Stream, 
    ByVal Dictionary As TesseractDictionary, 
    ByVal DictionaryPath As String, 
    ByVal CharWhiteList As String, 
    ByVal Title As String, 
    ByVal Author As String, 
    ByVal Subject As String, 
    ByVal Keywords As String, 
    ByVal Creator As String, 
    ByVal Encryption As PdfEncryption, 
    ByVal Rights As PdfRight, 
    ByVal UserPassword As String, 
    ByVal OwnerPassword As String
) As String

Parameters

Parameters	Description
ImageID	GdPicture Image Identifier.
PDFStream	The Stream object to save a GdPicture image.
Dictionary	The dictionary to use. A member of the TesseractDictionary enumeration.
DictionaryPath	The path into which the engine can find the dictionary files (see the TesseractDictionary enumeration).
CharWhiteList	This parameter can be used to specify your own white list of chars. IE: If you want to recognize only numeric you can use "0123456789". If you want to recognize only uppercase alpha you can use "ABCDEFGHIJKLMNOPQRSTUVWXYZ"... Use empty string to recognize all characters.
Title	The title of the PDF.
Author	The PDF Author.
Subject	The PDF Subject.
Keywords	The PDF Keywords.
Creator	The name of the application which creates the PDF.
Encryption	A member of the PdfEncryption enumeration. Note: AES encyption is not yet available.
Rights	A value returned by the PdfCreateRights function.
UserPassword	The user password for the PDF. Can be an empty string.
OwnerPassword	The owner password for the PDF. Can be an empty string.

Returns

The recognized text.

Remarks

This function requires the optional GdPicture Tesseract Plugin. This plugin must be unlocked with the SetLicenseNumberOCRTesseract() function.

Use the GetStat() function to determine if this function succeeded.