SaveAsDOCX(ICollection<String>,Stream,Boolean) Method
Saves the provided collection of OCR results, identifiable by their unique IDs, to a stream in the docx format.
public function SaveAsDOCX(
: ICollection;
: Stream;
: Boolean
): GdPictureStatus;
public function SaveAsDOCX(
: ICollection,
: Stream,
: boolean
) : GdPictureStatus;
public: GdPictureStatus SaveAsDOCX(
ICollection<string*>* ,
Stream* ,
bool
)
public:
GdPictureStatus SaveAsDOCX(
ICollection<String^>^ ,
Stream^ ,
bool
)
'Declaration
Public Overloads Function SaveAsDOCX( _
ByVal As ICollection(Of String), _
ByVal As Stream, _
ByVal As Boolean _
) As GdPictureStatus
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.
- 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.
How to save a collection of the OCR results to a stream in the docx format.
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
'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)()
'Define the required ROI.
gdpictureOCR.SetROI(100, 100, 200, 50)
'Define the character set for phone numbers.
gdpictureOCR.CharacterSet = "0123456789"
'Run the OCR process.
gdpictureOCR.RunOCR("PhoneNumberRegion")
If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
results.Add("PhoneNumberRegion")
Else
MessageBox.Show("The first OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
End If
'Reset the required ROI.
gdpictureOCR.SetROI(150, 300, 200, 200)
'Define the character set for addresses.
gdpictureOCR.CharacterSet = ""
gdpictureOCR.Context = OCRContext.OCRContextSingleBlock
'Run the OCR process.
gdpictureOCR.RunOCR("AddressRegion")
If gdpictureOCR.GetStat() = GdPictureStatus.OK Then
results.Add("AddressRegion")
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_result.docx", System.IO.FileMode.Create)
If gdpictureOCR.SaveAsDOCX(results, oStream, True) = GdPictureStatus.OK Then
MessageBox.Show("The OCR results has been successfully saved.", caption)
Else
MessageBox.Show("The SaveAsDOCX() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption)
End If
oStream.Dispose()
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: 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)
{
//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>();
//Define the required ROI.
gdpictureOCR.SetROI(100, 100, 200, 50);
//Define the character set for phone numbers.
gdpictureOCR.CharacterSet = "0123456789";
//Run the OCR process.
gdpictureOCR.RunOCR("PhoneNumberRegion");
if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
results.Add("PhoneNumberRegion");
else
MessageBox.Show("The first OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
//Reset the required ROI.
gdpictureOCR.SetROI(150, 300, 200, 200);
//Define the character set for addresses.
gdpictureOCR.CharacterSet = "";
gdpictureOCR.Context = OCRContext.OCRContextSingleBlock;
//Run the OCR process.
gdpictureOCR.RunOCR("AddressRegion");
if (gdpictureOCR.GetStat() == GdPictureStatus.OK)
results.Add("AddressRegion");
else
MessageBox.Show("The second OCR process has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
if (results.Count > 0)
{
System.IO.FileStream oStream = new System.IO.FileStream("OCR_result.docx", System.IO.FileMode.Create);
if (gdpictureOCR.SaveAsDOCX(results, oStream, true) == GdPictureStatus.OK)
MessageBox.Show("The OCR results has been successfully saved.", caption);
else
MessageBox.Show("The SaveAsDOCX() method has failed with the status: " + gdpictureOCR.GetStat().ToString(), caption);
oStream.Dispose();
}
//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();
}
