Main entry point for cleaning a PDF document. More...

Static Public Member Functions
static void	CleanUp (Stream inputPdf, Stream outputPdf, IList< iText.PdfCleanup.PdfCleanUpLocation > cleanUpLocations)
	Cleans the document by erasing all the areas which are provided. More...

static void	CleanUp (Stream inputPdf, Stream outputPdf, IList< iText.PdfCleanup.PdfCleanUpLocation > cleanUpLocations, CleanUpProperties properties)
	Cleans the document by erasing all the areas which are provided. More...

static void	CleanUp (PdfDocument pdfDocument, IList< iText.PdfCleanup.PdfCleanUpLocation > cleanUpLocations)
	Cleans the document by erasing all the areas which are provided. More...

static void	CleanUp (PdfDocument pdfDocument, IList< iText.PdfCleanup.PdfCleanUpLocation > cleanUpLocations, CleanUpProperties properties)
	Cleans the document by erasing all the areas which are provided. More...

static void	AutoSweepCleanUp (Stream inputPdf, Stream outputPdf, ICleanupStrategy strategy)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (Stream inputPdf, Stream outputPdf, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (Stream inputPdf, Stream outputPdf, ICleanupStrategy strategy, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (Stream inputPdf, Stream outputPdf, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfDocument pdfDocument, ICleanupStrategy strategy)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfDocument pdfDocument, ICleanupStrategy strategy, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfDocument pdfDocument, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfDocument pdfDocument, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfPage pdfPage, ICleanupStrategy strategy)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfPage pdfPage, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfPage pdfPage, ICleanupStrategy strategy, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	AutoSweepCleanUp (PdfPage pdfPage, ICleanupStrategy strategy, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations, CleanUpProperties properties)
	Perform cleanup of areas of interest based on a given cleanup strategy. More...

static void	CleanUpRedactAnnotations (Stream inputPdf, Stream outputPdf)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

static void	CleanUpRedactAnnotations (Stream inputPdf, Stream outputPdf, CleanUpProperties properties)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

static void	CleanUpRedactAnnotations (PdfDocument pdfDocument)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

static void	CleanUpRedactAnnotations (PdfDocument pdfDocument, CleanUpProperties properties)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

static void	CleanUpRedactAnnotations (Stream inputPdf, Stream outputPdf, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations)
	Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document. More...

static void	CleanUpRedactAnnotations (PdfDocument pdfDocument, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations)
	Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document. More...

static void	CleanUpRedactAnnotations (Stream inputPdf, Stream outputPdf, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations, CleanUpProperties properties)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

static void	CleanUpRedactAnnotations (PdfDocument pdfDocument, IList< iText.PdfCleanup.PdfCleanUpLocation > additionalCleanUpLocations, CleanUpProperties properties)
	Cleans the document by erasing regions defined by redact annotations inside the document. More...

Detailed Description

Main entry point for cleaning a PDF document.

Main entry point for cleaning a PDF document. This class contains a series of static methods that accept PDF file as a System.IO.Stream or already opened iText.Kernel.Pdf.PdfDocument and performs erasing of data in regions specified by input arguments. The output can either be preserved in passed iText.Kernel.Pdf.PdfDocument with possibility to post-process the document, or in an System.IO.Stream in a form of a complete PDF file.

The important difference between overloads with InputStream/OutputStream parameters and iText.Kernel.Pdf.PdfDocument parameter is in the consumption of product license limits.

Member Function Documentation

◆ AutoSweepCleanUp() [1/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfDocument	pdfDocument,
		ICleanupStrategy	strategy
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
strategy	cleanup strategy to be used

◆ AutoSweepCleanUp() [2/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfDocument	pdfDocument,
		ICleanupStrategy	strategy,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
strategy	cleanup strategy to be used
properties	additional properties for cleanUp

◆ AutoSweepCleanUp() [3/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfDocument	pdfDocument,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up

◆ AutoSweepCleanUp() [4/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfDocument	pdfDocument,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up
properties	additional properties for cleanUp

◆ AutoSweepCleanUp() [5/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfPage	pdfPage,
		ICleanupStrategy	strategy
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfPage	the iText.Kernel.Pdf.PdfPage to which cleaned up applies
strategy	cleanup strategy to be used

◆ AutoSweepCleanUp() [6/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfPage	pdfPage,
		ICleanupStrategy	strategy,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfPage	the iText.Kernel.Pdf.PdfPage to which cleaned up applies
strategy	cleanup strategy to be used
properties	additional properties for cleanUp

◆ AutoSweepCleanUp() [7/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfPage	pdfPage,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfPage	the iText.Kernel.Pdf.PdfPage to which cleaned up applies
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up

◆ AutoSweepCleanUp() [8/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	PdfPage	pdfPage,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfPage	the iText.Kernel.Pdf.PdfPage to which cleaned up applies
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up
properties	additional properties for cleanUp

◆ AutoSweepCleanUp() [9/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		ICleanupStrategy	strategy
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
strategy	cleanup strategy to be used

◆ AutoSweepCleanUp() [10/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		ICleanupStrategy	strategy,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
strategy	cleanup strategy to be used
properties	additional properties for cleanUp

◆ AutoSweepCleanUp() [11/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up

◆ AutoSweepCleanUp() [12/12]

static void iText.PdfCleanup.PdfCleaner.AutoSweepCleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		ICleanupStrategy	strategy,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Perform cleanup of areas of interest based on a given cleanup strategy.

Perform cleanup of areas of interest based on a given cleanup strategy. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
strategy	cleanup strategy to be used
additionalCleanUpLocations	list of additional locations to be cleaned up
properties	additional properties for cleanUp

◆ CleanUp() [1/4]

static void iText.PdfCleanup.PdfCleaner.CleanUp	(	PdfDocument	pdfDocument,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	cleanUpLocations
	)

inlinestatic

Cleans the document by erasing all the areas which are provided.

Cleans the document by erasing all the areas which are provided. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
cleanUpLocations	list of locations to be cleaned up

◆ CleanUp() [2/4]

static void iText.PdfCleanup.PdfCleaner.CleanUp	(	PdfDocument	pdfDocument,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	cleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing all the areas which are provided.

Cleans the document by erasing all the areas which are provided. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
cleanUpLocations	list of locations to be cleaned up
properties	additional properties for cleanUp

◆ CleanUp() [3/4]

static void iText.PdfCleanup.PdfCleaner.CleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	cleanUpLocations
	)

inlinestatic

Cleans the document by erasing all the areas which are provided.

Cleans the document by erasing all the areas which are provided. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
cleanUpLocations	list of locations to be cleaned up

◆ CleanUp() [4/4]

static void iText.PdfCleanup.PdfCleaner.CleanUp	(	Stream	inputPdf,
		Stream	outputPdf,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	cleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing all the areas which are provided.

Cleans the document by erasing all the areas which are provided. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
cleanUpLocations	list of locations to be cleaned up
properties	additional properties for cleanUp

◆ CleanUpRedactAnnotations() [1/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations ( PdfDocument pdfDocument )

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument a document to which cleaned up applies

◆ CleanUpRedactAnnotations() [2/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	PdfDocument	pdfDocument,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
properties	additional properties for cleanUp

◆ CleanUpRedactAnnotations() [3/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	PdfDocument	pdfDocument,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document.

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
additionalCleanUpLocations	list of locations to be cleaned up

◆ CleanUpRedactAnnotations() [4/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	PdfDocument	pdfDocument,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

pdfDocument	a document to which cleaned up applies
additionalCleanUpLocations	list of locations to be cleaned up
properties	additional properties for cleanUp

◆ CleanUpRedactAnnotations() [5/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	Stream	inputPdf,
		Stream	outputPdf
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream

◆ CleanUpRedactAnnotations() [6/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	Stream	inputPdf,
		Stream	outputPdf,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
properties	additional properties for cleanUp

◆ CleanUpRedactAnnotations() [7/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	Stream	inputPdf,
		Stream	outputPdf,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document.

Cleans the document by erasing regions defined by redact annotations and additional cleanup locations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
additionalCleanUpLocations	list of locations to be cleaned up

◆ CleanUpRedactAnnotations() [8/8]

static void iText.PdfCleanup.PdfCleaner.CleanUpRedactAnnotations	(	Stream	inputPdf,
		Stream	outputPdf,
		IList< iText.PdfCleanup.PdfCleanUpLocation >	additionalCleanUpLocations,
		CleanUpProperties	properties
	)

inlinestatic

Cleans the document by erasing regions defined by redact annotations inside the document.

Cleans the document by erasing regions defined by redact annotations inside the document. Note, use methods with InputStream/OutputStream params if you don't want to consume itext-core product license limits.

Parameters

inputPdf	the pdf document InputStream to which cleaned up applies
outputPdf	the cleaned up pdf document OutputStream
additionalCleanUpLocations	list of locations to be cleaned up
properties	additional properties for cleanUp

Static Public Member Functions

Detailed Description

Member Function Documentation

◆ AutoSweepCleanUp() [1/12]

◆ AutoSweepCleanUp() [2/12]

◆ AutoSweepCleanUp() [3/12]

◆ AutoSweepCleanUp() [4/12]

◆ AutoSweepCleanUp() [5/12]

◆ AutoSweepCleanUp() [6/12]

◆ AutoSweepCleanUp() [7/12]

◆ AutoSweepCleanUp() [8/12]

◆ AutoSweepCleanUp() [9/12]

◆ AutoSweepCleanUp() [10/12]

◆ AutoSweepCleanUp() [11/12]

◆ AutoSweepCleanUp() [12/12]

◆ CleanUp() [1/4]

◆ CleanUp() [2/4]

◆ CleanUp() [3/4]

◆ CleanUp() [4/4]

◆ CleanUpRedactAnnotations() [1/8]

◆ CleanUpRedactAnnotations() [2/8]

◆ CleanUpRedactAnnotations() [3/8]

◆ CleanUpRedactAnnotations() [4/8]

◆ CleanUpRedactAnnotations() [5/8]

◆ CleanUpRedactAnnotations() [6/8]

◆ CleanUpRedactAnnotations() [7/8]

◆ CleanUpRedactAnnotations() [8/8]