A collection of the unique OCR result identifiers. It specifies the OCR results you want to save.
The path to the file where the results will be saved. If the specified file already exists, it will be overwritten.
The text format of the output text file. A member of the OCROutputTextFormat enumeration.
The flag indicating whether to keep line breaks or not when saving the results.
Example





In This Topic
GdPicture14 Namespace / GdPictureOCR Class / SaveAsText Method / SaveAsText(ICollection<String>,String,OCROutputTextFormat,Boolean) Method

SaveAsText(ICollection<String>,String,OCROutputTextFormat,Boolean) Method

In This Topic
Saves the provided collection of OCR results, identifiable by their unique IDs, to a text file.
Syntax
'Declaration

 


Public Overloads Function SaveAsText( _

   ByVal OCRResultIDs As ICollection(Of String), _

   ByVal FilePath As String, _

   ByVal TextFormat As OCROutputTextFormat, _

   ByVal KeepLineBreaks As Boolean _

) As GdPictureStatus
public GdPictureStatus SaveAsText( 

   ICollection<string> OCRResultIDs,

   string FilePath,

   OCROutputTextFormat TextFormat,

   bool KeepLineBreaks

)
public function SaveAsText( 

    OCRResultIDs: ICollection;

    FilePath: String;

    TextFormat: OCROutputTextFormat;

    KeepLineBreaks: Boolean

): GdPictureStatus; 
public function SaveAsText( 

   OCRResultIDs : ICollection,

   FilePath : String,

   TextFormat : OCROutputTextFormat,

   KeepLineBreaks : boolean

) : GdPictureStatus;
public: GdPictureStatus SaveAsText( 

   ICollection<string*>* OCRResultIDs,

   string* FilePath,

   OCROutputTextFormat TextFormat,

   bool KeepLineBreaks

) 
public:

GdPictureStatus SaveAsText( 

   ICollection<String^>^ OCRResultIDs,

   String^ FilePath,

   OCROutputTextFormat TextFormat,

   bool KeepLineBreaks

)

Parameters

OCRResultIDs
A collection of the unique OCR result identifiers. It specifies the OCR results you want to save.
FilePath
The path to the file where the results will be saved. If the specified file already exists, it will be overwritten.
TextFormat
The text format of the output text file. A member of the OCROutputTextFormat enumeration.
KeepLineBreaks
The flag indicating whether to keep line breaks or not when saving the results.

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 a text file. 
Dim caption As String = "Example: SaveAsText"

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.

                If gdpictureOCR.SaveAsText(results, "OCR_results.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then

                    MessageBox.Show("The OCR results has been successfully saved.", caption)

                Else

                    MessageBox.Show("The SaveAsText() 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: SaveAsText";

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.

                if (gdpictureOCR.SaveAsText(results, "OCR_results.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK)

                    MessageBox.Show("The OCR results has been successfully saved.", caption);

                else

                    MessageBox.Show("The SaveAsText() 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();

}
Example
How to save a collection of the OCR results to a text file. Dim caption As String = "Example: SaveAsText" 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. If gdpictureOCR.SaveAsText(results, "OCR_results.txt", OCROutputTextFormat.Utf16, True) = GdPictureStatus.OK Then MessageBox.Show("The OCR results has been successfully saved.", caption) Else MessageBox.Show("The SaveAsText() 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: SaveAsText"; 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 results = new List(); //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. if (gdpictureOCR.SaveAsText(results, "OCR_results.txt", OCROutputTextFormat.Utf16, true) == GdPictureStatus.OK) MessageBox.Show("The OCR results has been successfully saved.", caption); else MessageBox.Show("The SaveAsText() 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

Reference

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