GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureOCR Class / GetKeyValuePairCount Method
The unique result identifier of the executed OCR process obtained by the GdPictureOCR.RunOCR method.
Example





In This Topic
GetKeyValuePairCount Method (GdPictureOCR)
In This Topic
Returns the number of extracted key-value pairs within a specified OCR result. Key-value pairs extraction is automatically performed during each OCR process.
Syntax
'Declaration
 
Public Function GetKeyValuePairCount( _
   ByVal OCRResultID As String _
) As Integer
public int GetKeyValuePairCount( 
   string OCRResultID
)
public function GetKeyValuePairCount( 
    OCRResultID: String
): Integer; 
public function GetKeyValuePairCount( 
   OCRResultID : String
) : int;
public: int GetKeyValuePairCount( 
   string* OCRResultID
) 
public:
int GetKeyValuePairCount( 
   String^ OCRResultID
) 

Parameters

OCRResultID
The unique result identifier of the executed OCR process obtained by the GdPictureOCR.RunOCR method.

Return Value

The number of detected key-value pairs.
Remarks

This method requires the KVP and Table Processing - Intelligent Redaction component to run.

Example
Extracting key-value pairs from an image.
string caption = "Example: KVP/OCR";
using (GdPictureOCR gdpictureOCR = new GdPictureOCR())
{
    //Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR";
    gdpictureOCR.EnableSkewDetection = true;
    if (gdpictureOCR.AddLanguage(OCRLanguage.English) == GdPictureStatus.OK)
    {
        //Set up the image you want to process.
        GdPictureImaging gdpictureImaging = new GdPictureImaging();
        //The standard open file dialog displays to allow you to select the file.
        int image = gdpictureImaging.CreateGdPictureImageFromFile("");
 
         gdpictureOCR.SetImage(image);
 
         string ocrResultID = gdpictureOCR.RunOCR();
 
         if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
         {
             string keyValuePairsData = "";
 
             for (int pairIdx = 0; pairIdx < gdpictureOCR.GetKeyValuePairCount(ocrResultID); pairIdx++)
             {
                 if (pairIdx != 0)
                 {
                      keyValuePairsData += "\n";
                 }
                 keyValuePairsData += "Name: "     + gdpictureOCR.GetKeyValuePairKeyString(ocrResultID, pairIdx) + " | " +
                                      "Value: "    + gdpictureOCR.GetKeyValuePairValueString(ocrResultID, pairIdx) + " | " +
                                      "Type: "     + gdpictureOCR.GetKeyValuePairDataType(ocrResultID, pairIdx).ToString() + " | " +
                                      "Accuracy: " + Math.Round(gdpictureOCR.GetKeyValuePairConfidence(ocrResultID, pairIdx), 1).ToString() + "%";
             }
             MessageBox.Show(keyValuePairsData, caption);
            }
            else
            {
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            //Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image);
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}
See Also