iText 8.0.2 API
iText.Kernel.Utils.TaggedPdfReaderTool Class Reference

Converts a tagged PDF document into an XML file. More...

Public Member Functions

  TaggedPdfReaderTool (PdfDocument document)
  Constructs a TaggedPdfReaderTool via a given iText.Kernel.Pdf.PdfDocument. More...
 
virtual void  ConvertToXml (Stream os)
  Converts the current tag structure into an XML file with default encoding (UTF-8). More...
 
virtual void  ConvertToXml (Stream os, String charset)
  Converts the current tag structure into an XML file with provided encoding. More...
 
virtual iText.Kernel.Utils.TaggedPdfReaderTool  SetRootTag (String rootTagName)
  Sets the name of the root tag of the resultant XML file More...
 

Static Public Member Functions

static bool  IsValidCharacterValue (int c)
  Checks if a character value should be escaped/unescaped. More...
 

Detailed Description

Converts a tagged PDF document into an XML file.

Constructor & Destructor Documentation

◆ TaggedPdfReaderTool()

iText.Kernel.Utils.TaggedPdfReaderTool.TaggedPdfReaderTool ( PdfDocument  document )
inline

Constructs a TaggedPdfReaderTool via a given iText.Kernel.Pdf.PdfDocument.

Parameters
document the document to read tag structure from

Member Function Documentation

◆ ConvertToXml() [1/2]

virtual void iText.Kernel.Utils.TaggedPdfReaderTool.ConvertToXml ( Stream  os )
inlinevirtual

Converts the current tag structure into an XML file with default encoding (UTF-8).

Parameters
os the output stream to save XML file to

◆ ConvertToXml() [2/2]

virtual void iText.Kernel.Utils.TaggedPdfReaderTool.ConvertToXml ( Stream  os,
String  charset 
)
inlinevirtual

Converts the current tag structure into an XML file with provided encoding.

Parameters
os the output stream to save XML file to
charset the charset of the resultant XML file

◆ IsValidCharacterValue()

static bool iText.Kernel.Utils.TaggedPdfReaderTool.IsValidCharacterValue ( int  c )
inlinestatic

Checks if a character value should be escaped/unescaped.

Parameters
c a character value
Returns
true if it's OK to escape or unescape this value

◆ SetRootTag()

virtual iText.Kernel.Utils.TaggedPdfReaderTool iText.Kernel.Utils.TaggedPdfReaderTool.SetRootTag ( String  rootTagName )
inlinevirtual

Sets the name of the root tag of the resultant XML file

Parameters
rootTagName the name of the root tag
Returns
this object