DocumentWriterInstance Property

Summary

Gets the instance of the DocumentWriter object being used inside this IOcrDocument.

Syntax

Objective-C

C++

Java

public DocumentWriter DocumentWriterInstance { get; }

ReadOnly Property DocumentWriterInstance As DocumentWriter

@property (nonatomic, strong, readonly) LTDocumentWriter *documentWriterInstance

public DocumentWriter getDocumentWriterInstance()

property DocumentWriter^ DocumentWriterInstance { 
   DocumentWriter^ get(); 
}

Property Value

The DocumentWriter object being used inside this IOcrDocument.

Remarks

The DocumentWriter object will be disposed of by the engine automatically when Dispose is called.

When new IOcrDocument objects are created using the IOcrDocumentManager.CreateDocument, a new object of type DocumentWriter is created by this IOcrEngine, and assigned to IOcrDocument.DocumentWriterInstance. All document creation operation (such as IOcrDocument.Save) that is performed inside by OCR document or objects inside the OCR document will use that object.

If the value of IOcrDocument.UseEngineInstanceOptions is true, then the options will be copied from the engine's DocumentWriter to the document DocumentWriter before any methods is called.

For more information on how this object is used by the OCR engine during its lifetime, refer to OCR Engine and RasterCodecs/DocumentWriter Usage.

Example

For an example, UseEngineInstanceOptions.

Requirements

Target Platforms