Pdf2Data 5.0.1 API
Loading...
Searching...
No Matches
Public Member Functions | Static Public Member Functions | List of all members
iText.Pdf2Data.RecognitionResultHolder Class Reference

Recognition result holder with methods to operate with the results. More...

Public Member Functions
  RecognitionResultHolder (RecognitionResult result)
  Creates an instance with specified result.
 
virtual RecognitionResult  GetResult ()
  Retrieve result object.
 
virtual void  WriteToJson (FileInfo outputJson)
  Writes holded result into the specified file as JSON.
 
virtual void  WriteToJson (FileInfo outputJson, SerializationProperties properties)
  Writes holded result into the specified file as JSON.
 
virtual void  WriteToJson (Stream jsonOutputStream)
  Writes holded result into the specified output stream as JSON.
 
virtual void  WriteToJson (Stream jsonOutputStream, SerializationProperties properties)
  Writes holded result into the specified output stream as JSON.
 
virtual void  WriteToXml (FileInfo outputXml)
  Saves recognition results to provided xml file.
 
virtual void  WriteToXml (FileInfo outputXml, SerializationProperties properties)
  Saves recognition results to provided xml file.
 
virtual void  WriteToXml (Stream xmlOutputStream)
  Saves recognition results to output stream in xml form.
 
virtual void  WriteToXml (Stream xmlOutputStream, SerializationProperties properties)
  Saves recognition results to output stream in xml form.
 

Static Public Member Functions
static iText.Pdf2Data.RecognitionResultHolder  ReadFromJson (Stream @is)
  Reads result from input stream containing the recognition result in JSON format.
 

Detailed Description

Recognition result holder with methods to operate with the results.

Constructor & Destructor Documentation

◆ RecognitionResultHolder()

iText.Pdf2Data.RecognitionResultHolder.RecognitionResultHolder ( RecognitionResult result )
inline

Creates an instance with specified result.

Parameters
result recognition result to be used in holder

Member Function Documentation

◆ GetResult()

virtual RecognitionResult iText.Pdf2Data.RecognitionResultHolder.GetResult ( )
inlinevirtual

Retrieve result object.

Returns

iText.Pdf2Data.Result.RecognitionResult instance

◆ ReadFromJson()

static iText.Pdf2Data.RecognitionResultHolder iText.Pdf2Data.RecognitionResultHolder.ReadFromJson ( Stream @ is )
inlinestatic

Reads result from input stream containing the recognition result in JSON format.

Parameters
is the System.IO.Stream to read from
Returns
an instance of RecognitionResultHolder based on the read result

◆ WriteToJson() [1/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToJson ( FileInfo outputJson )
inlinevirtual

Writes holded result into the specified file as JSON.

Parameters
outputJson the System.IO.FileInfo to write into

◆ WriteToJson() [2/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToJson ( FileInfo outputJson,
SerializationProperties properties )
inlinevirtual

Writes holded result into the specified file as JSON.

Parameters
outputJson the System.IO.FileInfo to write into
properties serialization properties

◆ WriteToJson() [3/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToJson ( Stream jsonOutputStream )
inlinevirtual

Writes holded result into the specified output stream as JSON.

Parameters
jsonOutputStream the System.IO.Stream to write into

◆ WriteToJson() [4/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToJson ( Stream jsonOutputStream,
SerializationProperties properties )
inlinevirtual

Writes holded result into the specified output stream as JSON.

Parameters
jsonOutputStream the System.IO.Stream to write into
properties serialization properties

◆ WriteToXml() [1/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToXml ( FileInfo outputXml )
inlinevirtual

Saves recognition results to provided xml file.

Parameters
outputXml xml file

◆ WriteToXml() [2/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToXml ( FileInfo outputXml,
SerializationProperties properties )
inlinevirtual

Saves recognition results to provided xml file.

Parameters
outputXml output stream
properties a SerializationProperties instance

◆ WriteToXml() [3/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToXml ( Stream xmlOutputStream )
inlinevirtual

Saves recognition results to output stream in xml form.

Parameters
xmlOutputStream output stream

◆ WriteToXml() [4/4]

virtual void iText.Pdf2Data.RecognitionResultHolder.WriteToXml ( Stream xmlOutputStream,
SerializationProperties properties )
inlinevirtual

Saves recognition results to output stream in xml form.

Parameters
xmlOutputStream output stream
properties a SerializationProperties instance