GdPicture.NET.14.API
GdPicture14 Namespace / GdPictureOCR Class / SaveAsXLSX Method / SaveAsXLSX(ICollection<String>,Stream,SpreadsheetOptions) Method
A collection of the unique OCR result identifiers. It specifies the OCR results you want to save.
A Stream object where the results will be saved to. This Stream object must be initialized before it can be sent into this method and it should remain open for subsequent use.
The class that handles different options requested by a GdPictureOCR instance to export OCR result to a spreadsheet document.
Example





In This Topic
SaveAsXLSX(ICollection<String>,Stream,SpreadsheetOptions) Method
In This Topic
Saves the provided collection of OCR results, identifiable by their unique IDs, to a stream in the xlsx format.
Syntax
'Declaration
 
Public Overloads Function SaveAsXLSX( _
   ByVal OCRResultIDs As ICollection(Of String), _
   ByVal Stream As Stream, _
   Optional ByVal SpreadsheetOptions As GdPictureOCR.SpreadsheetOptions _
) As GdPictureStatus
public GdPictureStatus SaveAsXLSX( 
   ICollection<string> OCRResultIDs,
   Stream Stream,
   GdPictureOCR.SpreadsheetOptions SpreadsheetOptions
)
public function SaveAsXLSX( 
    OCRResultIDs: ICollection;
    Stream: Stream;
    SpreadsheetOptions: GdPictureOCR.SpreadsheetOptions
): GdPictureStatus; 
public function SaveAsXLSX( 
   OCRResultIDs : ICollection,
   Stream : Stream,
   SpreadsheetOptions : GdPictureOCR.SpreadsheetOptions
) : GdPictureStatus;
public: GdPictureStatus SaveAsXLSX( 
   ICollection<string*>* OCRResultIDs,
   Stream* Stream,
   GdPictureOCR.SpreadsheetOptions* SpreadsheetOptions
) 
public:
GdPictureStatus SaveAsXLSX( 
   ICollection<String^>^ OCRResultIDs,
   Stream^ Stream,
   GdPictureOCR.SpreadsheetOptions^ SpreadsheetOptions
) 

Parameters

OCRResultIDs
A collection of the unique OCR result identifiers. It specifies the OCR results you want to save.
Stream
A Stream object where the results will be saved to. This Stream object must be initialized before it can be sent into this method and it should remain open for subsequent use.
SpreadsheetOptions
The class that handles different options requested by a GdPictureOCR instance to export OCR result to a spreadsheet document.

Return Value

A member of the GdPictureStatus enumeration. If the method has been successfully followed, then the return value is GdPictureStatus.OK.

We strongly recommend always checking this status first.

Example
How to save a collection of the OCR results to an xlsx file.
Dim caption As String = "Example: SaveAsXLSX"
Using gdpictureOCR As GdPictureOCR = New GdPictureOCR
    'Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR"
    If gdpictureOCR.AddLanguage(OCRLanguage.English) = GdPictureStatus.OK Then
        'Set up the image you want to process.
        Dim gdpictureImaging As GdPictureImaging = New GdPictureImaging
        'The standard open file dialog displays to allow you to select the file.
        Dim image As Integer = gdpictureImaging.CreateGdPictureImageFromFile("")
        If (gdpictureImaging.GetStat = GdPictureStatus.OK) AndAlso
           (gdpictureOCR.SetImage(image) = GdPictureStatus.OK) Then
            Dim results As List(Of String) = New List(Of String)()
 
            'Run the first OCR process.
            'Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            Dim resID1 As String = gdpictureOCR.RunOCR
            If gdpictureOCR.GetStat = GdPictureStatus.OK Then
                results.Add(resID1)
            Else
                MessageBox.Show("The first OCR process has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
            End If
 
            'Change OCR settings.
            gdpictureOCR.OCRMode = OCRMode.FavorAccuracy
 
            'Run the second OCR process.
            Dim resID2 As String = gdpictureOCR.RunOCR
            If gdpictureOCR.GetStat = GdPictureStatus.OK Then
                results.Add(resID2)
            Else
                MessageBox.Show("The second OCR process has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
            End If
 
            If results.Count > 0 Then
                'Save the results.
                Dim oStream As System.IO.FileStream = New System.IO.FileStream("OCR_results.xlsx", System.IO.FileMode.Create)
                Dim spreadsheetOptions As GdPictureOCR.SpreadsheetOptions = New GdPictureOCR.SpreadsheetOptions() With {               
                    .SeparateTables = false
                }
                If gdpictureOCR.SaveAsXLSX(results, oStream, spreadsheetOptions) = GdPictureStatus.OK Then
                    MessageBox.Show("The OCR results has been successfully saved.", caption)
                Else
                    MessageBox.Show("The SaveAsXLSX() method has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
                End If
 
            End If
            'Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image)
        Else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat.ToString + " or " + gdpictureOCR.GetStat.ToString, caption)
        End If
        gdpictureImaging.Dispose()
    Else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
    End If
    gdpictureOCR.ReleaseOCRResults()
End Using
string caption = "Example: SaveAsXLSX";
using (GdPictureOCR gdpictureOCR = new GdPictureOCR())
{
    //Set up your prefered parameters for OCR.
    gdpictureOCR.ResourcesFolder = "\\GdPicture.Net 14\\redist\\OCR";
    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("");
        if ((gdpictureImaging.GetStat() == GdPictureStatus.OK) &&
            (gdpictureOCR.SetImage(image) == GdPictureStatus.OK))
        {
            List<string> results = new List<string>();
 
            //Run the first OCR process.
            //Note that gdpictureOCR.OCRMode = OCRMode.FavorSpeed by default.
            string resID1 = gdpictureOCR.RunOCR();
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
                results.Add(resID1);
            else
                MessageBox.Show("The first OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
 
            //Change OCR settings.
            gdpictureOCR.OCRMode = OCRMode.FavorAccuracy;
 
            //Run the second OCR process.
            string resID2 = gdpictureOCR.RunOCR();
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
                results.Add(resID2);
            else
                MessageBox.Show("The second OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
 
            if (results.Count > 0)
            {
                //Save the results.
                System.IO.FileStream oStream = new System.IO.FileStream("OCR_results.xlsx", System.IO.FileMode.Create);
                GdPictureOCR.SpreadsheetOptions spreadsheetOptions = new GdPictureOCR.SpreadsheetOptions()
                {
                    SeparateTables = false
                };                
            
                if (gdpictureOCR.SaveAsXLSX(results, oStream, spreadsheetOptions) == GdPictureStatus.OK)
                    MessageBox.Show("The OCR results has been successfully saved.", caption);
                else
                    MessageBox.Show("The SaveAsXLSX() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
            }
            //Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image);
        }
        else
            MessageBox.Show("The error occurred when setting up the image: " + gdpictureImaging.GetStat().ToString() + " or " + gdpictureOCR.GetStat().ToString(), caption);
        gdpictureImaging.Dispose();
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}
See Also