SaveAsDOCX(String,Stream,Boolean) Method

In This Topic

Saves the provided OCR result, identifiable by its unique ID, to a stream in the docx format.

Syntax

Visual Basic
C#
Delphi
JScript
Managed Extensions for C++
C++/CLI

'Declaration
 
Public Overloads Function SaveAsDOCX( _
   ByVal OCRResultID As String, _
   ByVal Stream As Stream, _
   ByVal KeepLineBreaks As Boolean _
) As GdPictureStatus

public GdPictureStatus SaveAsDOCX( 
   string OCRResultID,
   Stream Stream,
   bool KeepLineBreaks
)

public function SaveAsDOCX( 
    OCRResultID: String;
    Stream: Stream;
    KeepLineBreaks: Boolean
): GdPictureStatus;

public function SaveAsDOCX( 
   OCRResultID : String,
   Stream : Stream,
   KeepLineBreaks : boolean
) : GdPictureStatus;

public: GdPictureStatus SaveAsDOCX( 
   string* OCRResultID,
   Stream* Stream,
   bool KeepLineBreaks
)

public:
GdPictureStatus SaveAsDOCX( 
   String^ OCRResultID,
   Stream^ Stream,
   bool KeepLineBreaks
)

Parameters

OCRResultID: A unique result identifier of the executed OCR process obtained by the RunOCR method. It specifies the OCR result you want to save.
Stream: A Stream object where the result 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.
KeepLineBreaks: The flag indicating whether to keep line breaks or not when saving the result.

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.

Remarks

The output stream should be open for writing and should be closed/disposed by the user as well.

Example

How to save the result to a stream in docx format when processing the OCR on the selected image.

VB.NET
C#

Dim caption As String = "Example: SaveAsDOCX"
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
        'Load 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
            'Setting up the image is mandatory.
            'Run the OCR process.
            Dim resID As String = gdpictureOCR.RunOCR()
            If gdpictureOCR.GetStat = GdPictureStatus.OK Then
                Dim oStream As System.IO.FileStream = New System.IO.FileStream("OCR_result.docx", System.IO.FileMode.Create)
                'Save the result.
                If gdpictureOCR.SaveAsDOCX(resID, oStream, True) = GdPictureStatus.OK Then
                    MessageBox.Show("The OCR result has been successfully saved.", caption)
                Else
                    MessageBox.Show("The SaveAsDOCX() method has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
                End If
                oStream.Dispose()
            Else
                MessageBox.Show("The OCR process has failed with the status: " + gdpictureOCR.GetStat.ToString, caption)
            End If
            'Release the used image.
            gdpictureImaging.ReleaseGdPictureImage(image)
        Else
            MessageBox.Show("The error occurred when creating or setting up the image. Status: " + gdpictureImaging.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: SaveAsDOCX";
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)
    {
        //Load 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)) //Setting up the image is mandatory.
        {
            //Run the OCR process.
            string resID = gdpictureOCR.RunOCR();
            if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
            {
                System.IO.FileStream oStream = new System.IO.FileStream("OCR_result.docx", System.IO.FileMode.Create);
                //Save the result.
                if (gdpictureOCR.SaveAsDOCX(resID, oStream, true) == GdPictureStatus.OK)
                    MessageBox.Show("The OCR result has been successfully saved.", caption);
                else
                    MessageBox.Show("The SaveAsDOCX() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
                oStream.Dispose();
            }
            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 error occurred when creating or setting up the image. Status: " + gdpictureImaging.GetStat().ToString(), caption);
        gdpictureImaging.Dispose();
    }
    else
        MessageBox.Show("The AddLanguage() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
    gdpictureOCR.ReleaseOCRResults();
}

Reference

GdPictureOCR Class
GdPictureOCR Members
Overload List
RunOCR Method
GetOCRResultText(String) Method
SaveAsText(String,String,OCROutputTextFormat,Boolean) Method
SaveAsHTML(String,String,Boolean) Method