IsStarted Property (original) (raw)
Summary
Determines whether this IOcrEngine has been started and is ready to be used.
Syntax
C#
Objective-C
C++/CLI
Java
Python
public bool IsStarted { get; }
@property (nonatomic, assign, readonly) BOOL isStarted
public boolean isStarted()
property bool IsStarted {
bool get();
}
Property Value
true if this IOcrEngine has been started and is ready to be used, otherwise it is false.
Example
using Leadtools;
using Leadtools.Codecs;
using Leadtools.Ocr;
using Leadtools.Document.Writer;
public void StartupEngineExample()
{
// Use RasterCodecs to load an image file
// Note: You can let the engine load the image file directly as shown in the other examples
RasterCodecs codecs = new RasterCodecs();
RasterImage image = codecs.Load(Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.tif"));
// Assume you copied the engine runtime files to C:\MyApp\Ocr
string engineDir = @"C:\MyApp\Ocr";
// Store the engine work directory into a path inside our application
string workDir = @"C:\MyApp\OcrTemp";
// Delete all files in the work directory in case the previous version of our application exited abnormally and
// the engine did not get the chance to clean all of its temporary files (if any)
Directory.Delete(workDir, true);
// Re-create the work directory
Directory.CreateDirectory(workDir);
// Create an instance of the engine
using (IOcrEngine ocrEngine = OcrEngineManager.CreateEngine(OcrEngineType.LEAD))
{
// Show that the engine has not been started yet
Console.WriteLine("Before calling Startup, IsStarted = " + ocrEngine.IsStarted);
// Start the engine using our parameters
// Since we already have a RasterCodecs object, we can re-use it to save memory and resources
ocrEngine.Startup(codecs, null, workDir, engineDir);
// Make sure the engine is using our working directory
Console.WriteLine("workDir passed is {0}, the value of WorkDirectory after Startup is {1}", workDir, ocrEngine.WorkDirectory);
// Show that the engine has started fine
Console.WriteLine("After calling Startup, EngineType is {0}, IsStarted = {1}", ocrEngine.EngineType, ocrEngine.IsStarted);
// Maks sure the engine is using our own version of RasterCodecs
Debug.Assert(codecs == ocrEngine.RasterCodecsInstance);
// Create a page from the raster image as page to the document
IOcrPage ocrPage = ocrEngine.CreatePage(image, OcrImageSharingMode.AutoDispose);
// image belongs to the page and will be dispose when the page is disposed
// Recognize the page
// Note, Recognize can be called without calling AutoZone or manually adding zones. The engine will
// check and automatically auto-zones the page
ocrPage.Recognize(null);
// Create a file based document
using (IOcrDocument ocrDocument = ocrEngine.DocumentManager.CreateDocument(null, OcrCreateDocumentOptions.AutoDeleteFile))
{
// Add the page
ocrDocument.Pages.Add(ocrPage);
// No need for the page anymore
ocrPage.Dispose();
// Save the document we have as PDF
string pdfFileName = Path.Combine(LEAD_VARS.ImagesDir, "Ocr1.pdf");
ocrDocument.Save(pdfFileName, DocumentFormat.Pdf, null);
}
// Shutdown the engine
// Note: calling Dispose will also automatically shutdown the engine if it has been started
ocrEngine.Shutdown();
}
}
static class LEAD_VARS
{
public const string ImagesDir = @"C:\LEADTOOLS22\Resources\Images";
}