GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureOCR Class / GetWordRecognitionLanguage Method
The unique result identifier of the executed OCR process obtained by the GdPictureOCR.RunOCR method.
The 0-based index of the word within the specified OCR result. It must be a value between 0 and GdPictureOCR.GetWordCount(OCRResultID) - 1.
Example





In This Topic
GetWordRecognitionLanguage Method (GdPictureOCR)
In This Topic
Returns the name of the language used to recognize the specified word, that is a part of a specified OCR result.
Syntax
'Declaration
 
Public Function GetWordRecognitionLanguage( _
   ByVal OCRResultID As String, _
   ByVal WordIdx As Integer _
) As String
public string GetWordRecognitionLanguage( 
   string OCRResultID,
   int WordIdx
)
public function GetWordRecognitionLanguage( 
    OCRResultID: String;
    WordIdx: Integer
): String; 
public function GetWordRecognitionLanguage( 
   OCRResultID : String,
   WordIdx : int
) : String;
public: string* GetWordRecognitionLanguage( 
   string* OCRResultID,
   int WordIdx
) 
public:
String^ GetWordRecognitionLanguage( 
   String^ OCRResultID,
   int WordIdx
) 

Parameters

OCRResultID
The unique result identifier of the executed OCR process obtained by the GdPictureOCR.RunOCR method.
WordIdx
The 0-based index of the word within the specified OCR result. It must be a value between 0 and GdPictureOCR.GetWordCount(OCRResultID) - 1.

Return Value

The name of the used language. Please always use the GdPictureOCR.GetStat method to determine if this method has been successful.
Remarks
It is recommend to use the GdPictureOCR.GetStat method to identify the specific reason for the method's failure, if any.
Example
How to find out the number of recognized words within the OCR result and some of the word's properties.
Dim caption As String = "Example: GetWordRecognitionLanguage"
Dim gdpictureOCR As GdPictureOCR = New GdPictureOCR
Dim gdpicturePDF As GdPicturePDF = New GdPicturePDF
'Load the PDF document.
If gdpicturePDF.LoadFromFile("input.pdf", False) = GdPictureStatus.OK Then
    'Select the first page.
    gdpicturePDF.SelectPage(1)
    'Render this page to a 200 DPI image.
    Dim image As Integer = gdpicturePDF.RenderPageToGdPictureImage(200, True)
    If gdpicturePDF.GetStat = GdPictureStatus.OK AndAlso
       gdpictureOCR.SetImage(image) = GdPictureStatus.OK Then
        'Setting up the image is mandatory.
        'Set up the OCR parameters.
        gdpictureOCR.ResourcesFolder = "C:\Path\To\GdPicture.NET 14\Redist\OCR"
        'Release default languages.
        gdpictureOCR.ResetSelectedDictionaries()
        'Add required languages.
        gdpictureOCR.AddLanguage(OCRLanguage.Slovak)
        gdpictureOCR.AddLanguage(OCRLanguage.Czech)
        'Set up the OCR mode.
        gdpictureOCR.OCRMode = OCRMode.FavorAccuracy
        'Set up the OCR context and the character list.
        gdpictureOCR.Context = OCRContext.OCRContextSingleBlock
        gdpictureOCR.CharacterSet = ""
        'Set up the area to be processed by the OCR.
        gdpictureOCR.SetROI(100, 100, 200, 200)
        'Run the OCR process.
        Dim resID As String = gdpictureOCR.RunOCR()
        If gdpictureOCR.GetStat = GdPictureStatus.OK Then
            Dim wordCount As Integer = gdpictureOCR.GetWordCount(resID)
            If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
                Dim message As String = "The number of recognized words: " + wordCount.ToString()
                'Analyze the results.
                For i As Integer = 0 To wordCount - 1
                    message = message + vbCrLf + i.ToString() + ".word: " + gdpictureOCR.GetWordValue(resID, i) +
                    message = "    IsFromDict: " + gdpictureOCR.GetWordIsFromDictionary(resID, i).ToString() +
                    message = "    Language: " + gdpictureOCR.GetWordRecognitionLanguage(resID, i) + vbCrLf +
                    message = "    Font: " + gdpictureOCR.GetWordFontFamilyName(resID, i) +
                              "    size: " + gdpictureOCR.GetWordFontSize(resID, i).ToString() +
                              "    style: " + gdpictureOCR.GetWordFontStyle(resID, i).ToString() + vbCrLf +
                              "    monospaced" + gdpictureOCR.GetWordFontIsMonospaced(resID, i).ToString() +
                              "    serif" + gdpictureOCR.GetWordFontIsSerif(resID, i).ToString() +
                              "    smallcaps" + gdpictureOCR.GetWordFontIsSmallcaps(resID, i).ToString()
                Next
                MessageBox.Show(message, caption)
            Else
                MessageBox.Show("The GetWordCount() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
            End If
        Else
            MessageBox.Show("The error occurred when running the OCR. Status: " + gdpictureOCR.GetStat().ToString(), caption)
        End If
        'Release the image.
        GdPictureDocumentUtilities.DisposeImage(image)
    Else
        MessageBox.Show("The error occurred when creating or setting up the image. Status: " + gdpicturePDF.GetStat().ToString() + "/" + gdpictureOCR.GetStat().ToString(), caption)
    End If
    'Close the document.
    gdpicturePDF.CloseDocument()
Else
    MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption)
End If
'Release resources.
gdpictureOCR.ReleaseOCRResults()
gdpictureOCR.Dispose()
gdpicturePDF.Dispose()
string caption = "Example: GetWordRecognitionLanguage";
GdPictureOCR gdpictureOCR = new GdPictureOCR();
GdPicturePDF gdpicturePDF = new GdPicturePDF();
//Load the PDF document.
if (gdpicturePDF.LoadFromFile("input.pdf", false) == GdPictureStatus.OK)
{
    //Select the first page.
    gdpicturePDF.SelectPage(1);
    //Render this page to a 200 DPI image.
    int image = gdpicturePDF.RenderPageToGdPictureImage(200, true);
    if ((gdpicturePDF.GetStat() == GdPictureStatus.OK) &&
        (gdpictureOCR.SetImage(image) == GdPictureStatus.OK)) //Setting up the image is mandatory.
    {
        //Set up the OCR parameters.
        gdpictureOCR.ResourcesFolder = "C:\\Path\\To\\GdPicture.NET 14\\Redist\\OCR";
        //Release default languages.
        gdpictureOCR.ResetSelectedDictionaries();
        //Add required languages.
        gdpictureOCR.AddLanguage(OCRLanguage.Slovak);
        gdpictureOCR.AddLanguage(OCRLanguage.Czech);
        //Set up the OCR mode.
        gdpictureOCR.OCRMode = OCRMode.FavorAccuracy;
        //Set up the OCR context and the character list.
        gdpictureOCR.Context = OCRContext.OCRContextSingleBlock;
        gdpictureOCR.CharacterSet = "";
        //Set up the area to be processed by the OCR.
        gdpictureOCR.SetROI(100, 100, 200, 200);
        //Run the OCR process.
        string resID = gdpictureOCR.RunOCR();
        if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
        {
            int wordCount = gdpictureOCR.GetWordCount(resID);
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
            {
                string message = "The number of recognized words: " + wordCount.ToString();
                //Analyze the results.
                for (int i = 0; i < wordCount; i++)
                {
                    message = message + "\n" + i.ToString() + ".word: " + gdpictureOCR.GetWordValue(resID, i) +
                    message = "    IsFromDict: " + gdpictureOCR.GetWordIsFromDictionary(resID, i).ToString() +
                    message = "    Language: " + gdpictureOCR.GetWordRecognitionLanguage(resID, i) +
                    message = "\n    Font: " + gdpictureOCR.GetWordFontFamilyName(resID, i) +
                              "    size: " + gdpictureOCR.GetWordFontSize(resID, i).ToString() +
                              "    style: " + gdpictureOCR.GetWordFontStyle(resID, i).ToString() +
                              "\n:    monospaced" + gdpictureOCR.GetWordFontIsMonospaced(resID, i).ToString() +
                              "    serif" + gdpictureOCR.GetWordFontIsSerif(resID, i).ToString() +
                              "    smallcaps" + gdpictureOCR.GetWordFontIsSmallcaps(resID, i).ToString();
                }
                MessageBox.Show(message, caption);
            }
            else
                MessageBox.Show("The GetWordCount() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
        }
        else
            MessageBox.Show("The error occurred when running the OCR. Status: " + gdpictureOCR.GetStat().ToString(), caption);
        //Release the image.
        GdPictureDocumentUtilities.DisposeImage(image);
    }
    else
        MessageBox.Show("The error occurred when creating or setting up the image. Status: " + gdpicturePDF.GetStat().ToString() + "/" + gdpictureOCR.GetStat().ToString(), caption);
    //Close the document.
    gdpicturePDF.CloseDocument();
}
else
    MessageBox.Show("The file can't be loaded. Status: " + gdpicturePDF.GetStat().ToString(), caption);
//Release resources.
gdpictureOCR.ReleaseOCRResults();
gdpictureOCR.Dispose();
gdpicturePDF.Dispose();
See Also