pdfOptimizer 3.0.1 API
iText.Pdfoptimizer.PdfOptimizer Class Reference

Entry point for Pdf Optimization process. More...

Public Member Functions

  PdfOptimizer ()
  Creates a new instance of PdfOptimizer, the main entry point of the optimization process. More...
 
virtual iText.Pdfoptimizer.PdfOptimizer  AddOptimizationHandler (AbstractOptimizationHandler handler)
  Appends provided instance of AbstractOptimizationHandler to the current handler chain. More...
 
virtual void  SetReportBuilder (DefaultReportBuilder reportBuilder)
  Sets a custom instance of iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder. More...
 
virtual OptimizationResult  Optimize (FileInfo inputFile, FileInfo outputFile)
  Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.FileInfo and writes its optimized version in the new file. More...
 
virtual OptimizationResult  Optimize (FileInfo inputFile, Stream outputStream)
  Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.FileInfo and writes its optimized version in the provided System.IO.Stream. More...
 
virtual OptimizationResult  Optimize (Stream inputStream, FileInfo outputFile)
  Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.Stream and writes its optimized version in the new file. More...
 
virtual OptimizationResult  Optimize (Stream inputStream, Stream outputStream)
  Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.Stream and writes its optimized version in the provided System.IO.Stream. More...
 
virtual OptimizationResult  Optimize (PdfReader reader, FileInfo outputFile)
  Reads iText.Kernel.Pdf.PdfDocument from provided iText.Kernel.Pdf.PdfReader and writes its optimized version in the new file. More...
 
virtual OptimizationResult  Optimize (PdfReader reader, Stream outputStream)
  Reads iText.Kernel.Pdf.PdfDocument from provided iText.Kernel.Pdf.PdfReader and writes its optimized version in the provided System.IO.Stream. More...
 

Detailed Description

Entry point for Pdf Optimization process.

Entry point for Pdf Optimization process. Each Pdf Optimizer can be configured with required set of AbstractOptimizationHandler instances. Optimizer requires fully populated instance of iText.Kernel.Pdf.PdfDocument to perform valid optimization. Processing of raw PdfDocument without all the calculations done may lead to unexpected and incorrect behaviour. That is why it is only allowed to pass the source of Pdf file instead of PdfDocument instance itself.

Constructor & Destructor Documentation

◆ PdfOptimizer()

iText.Pdfoptimizer.PdfOptimizer.PdfOptimizer ( )
inline

Creates a new instance of PdfOptimizer, the main entry point of the optimization process.

Member Function Documentation

◆ AddOptimizationHandler()

virtual iText.Pdfoptimizer.PdfOptimizer iText.Pdfoptimizer.PdfOptimizer.AddOptimizationHandler ( AbstractOptimizationHandler  handler )
inlinevirtual

Appends provided instance of AbstractOptimizationHandler to the current handler chain.

Parameters
handler is an optimization handler
Returns
this instance

◆ Optimize() [1/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( FileInfo  inputFile,
FileInfo  outputFile 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.FileInfo and writes its optimized version in the new file.

Parameters
inputFile is a source of the PDF document
outputFile is a file where optimized document will be stored
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ Optimize() [2/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( FileInfo  inputFile,
Stream  outputStream 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.FileInfo and writes its optimized version in the provided System.IO.Stream.

Parameters
inputFile is a source of the PDF document
outputStream is an output stream for optimized document
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ Optimize() [3/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( PdfReader  reader,
FileInfo  outputFile 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided iText.Kernel.Pdf.PdfReader and writes its optimized version in the new file.

Parameters
reader is a source of the PDF document
outputFile is a file where optimized document will be stored
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ Optimize() [4/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( PdfReader  reader,
Stream  outputStream 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided iText.Kernel.Pdf.PdfReader and writes its optimized version in the provided System.IO.Stream.

Parameters
reader is a source of the PDF document
outputStream is an output stream for optimized document
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ Optimize() [5/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( Stream  inputStream,
FileInfo  outputFile 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.Stream and writes its optimized version in the new file.

Parameters
inputStream is a source of the PDF document
outputFile is a file where optimized document will be stored
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ Optimize() [6/6]

virtual OptimizationResult iText.Pdfoptimizer.PdfOptimizer.Optimize ( Stream  inputStream,
Stream  outputStream 
)
inlinevirtual

Reads iText.Kernel.Pdf.PdfDocument from provided System.IO.Stream and writes its optimized version in the provided System.IO.Stream.

Parameters
inputStream is a source of the PDF document
outputStream is an output stream for optimized document
Returns
optimization process report as iText.Pdfoptimizer.Report.OptimizationResult

◆ SetReportBuilder()

virtual void iText.Pdfoptimizer.PdfOptimizer.SetReportBuilder ( DefaultReportBuilder  reportBuilder )
inlinevirtual

Sets a custom instance of iText.Pdfoptimizer.Report.Builder.DefaultReportBuilder.

Parameters
reportBuilder is a report builder