pdfSweep 2.0.5 API
Classes | Public Member Functions | List of all members
iText.PdfCleanup.Autosweep.PdfAutoSweep Class Reference

Class that automatically extracts all regions of interest from a given PdfDocument and redacts them. More...

Public Member Functions
  PdfAutoSweep (ICleanupStrategy strategy)
  Construct a new instance of PdfAutoSweep with a given ICleanupStrategy More...
 
virtual IList< PdfCleanUpLocation >  GetPdfCleanUpLocations (PdfPage page)
  Get all iText.PdfCleanup.PdfCleanUpLocation objects from a given iText.Kernel.Pdf.PdfPage More...
 
virtual IList< PdfCleanUpLocation >  GetPdfCleanUpLocations (PdfDocument doc)
  Get all iText.PdfCleanup.PdfCleanUpLocation objects from a given iText.Kernel.Pdf.PdfDocument More...
 
virtual void  Highlight (PdfDocument pdfDocument)
  Highlight areas of interest in a given iText.Kernel.Pdf.PdfDocument More...
 
virtual void  Highlight (PdfPage pdfPage)
  Highlight areas of interest in a given iText.Kernel.Pdf.PdfPage More...
 
virtual void  CleanUp (PdfDocument pdfDocument)
  Perform cleanup of areas of interest on a given iText.Kernel.Pdf.PdfDocument More...
 
virtual void  CleanUp (PdfPage pdfPage)
  Perform cleanup of areas of interest on a given iText.Kernel.Pdf.PdfPage More...
 
virtual void  TentativeCleanUp (PdfDocument pdfDocument)
  Perform tentative cleanup of areas of interest on a given iText.Kernel.Pdf.PdfDocument This method will add all redaction annotations to the given document, allowing the end-user to choose which redactions to keep or delete. More...
 
virtual void  TentativeCleanUp (PdfPage pdfPage)
  Perform tentative cleanup of areas of interest on a given iText.Kernel.Pdf.PdfPage This method will add all redaction annotations to the given page, allowing the end-user to choose which redactions to keep or delete. More...
 

Detailed Description

Class that automatically extracts all regions of interest from a given PdfDocument and redacts them.

Constructor & Destructor Documentation

◆ PdfAutoSweep()

iText.PdfCleanup.Autosweep.PdfAutoSweep.PdfAutoSweep ( ICleanupStrategy  strategy )
inline

Construct a new instance of PdfAutoSweep with a given ICleanupStrategy

Parameters
strategy the redaction strategy to be used

Member Function Documentation

◆ CleanUp() [1/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.CleanUp ( PdfDocument  pdfDocument )
inlinevirtual

Perform cleanup of areas of interest on a given iText.Kernel.Pdf.PdfDocument

Parameters
pdfDocument the iText.Kernel.Pdf.PdfDocument to be redacted

◆ CleanUp() [2/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.CleanUp ( PdfPage  pdfPage )
inlinevirtual

Perform cleanup of areas of interest on a given iText.Kernel.Pdf.PdfPage

Parameters
pdfPage the iText.Kernel.Pdf.PdfPage to be redacted

◆ GetPdfCleanUpLocations() [1/2]

virtual IList<PdfCleanUpLocation> iText.PdfCleanup.Autosweep.PdfAutoSweep.GetPdfCleanUpLocations ( PdfDocument  doc )
inlinevirtual

Get all iText.PdfCleanup.PdfCleanUpLocation objects from a given iText.Kernel.Pdf.PdfDocument

Parameters
doc the iText.Kernel.Pdf.PdfDocument to be processed
Returns
a List of iText.PdfCleanup.PdfCleanUpLocation objects

◆ GetPdfCleanUpLocations() [2/2]

virtual IList<PdfCleanUpLocation> iText.PdfCleanup.Autosweep.PdfAutoSweep.GetPdfCleanUpLocations ( PdfPage  page )
inlinevirtual

Get all iText.PdfCleanup.PdfCleanUpLocation objects from a given iText.Kernel.Pdf.PdfPage

Parameters
page the iText.Kernel.Pdf.PdfPage to be processed
Returns
a List of iText.PdfCleanup.PdfCleanUpLocation objects

◆ Highlight() [1/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.Highlight ( PdfDocument  pdfDocument )
inlinevirtual

Highlight areas of interest in a given iText.Kernel.Pdf.PdfDocument

Parameters
pdfDocument the iText.Kernel.Pdf.PdfDocument to be highlighted

◆ Highlight() [2/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.Highlight ( PdfPage  pdfPage )
inlinevirtual

Highlight areas of interest in a given iText.Kernel.Pdf.PdfPage

Parameters
pdfPage the iText.Kernel.Pdf.PdfPage to be highlighted

◆ TentativeCleanUp() [1/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.TentativeCleanUp ( PdfDocument  pdfDocument )
inlinevirtual

Perform tentative cleanup of areas of interest on a given iText.Kernel.Pdf.PdfDocument This method will add all redaction annotations to the given document, allowing the end-user to choose which redactions to keep or delete.

Parameters
pdfDocument the document to clean up

◆ TentativeCleanUp() [2/2]

virtual void iText.PdfCleanup.Autosweep.PdfAutoSweep.TentativeCleanUp ( PdfPage  pdfPage )
inlinevirtual

Perform tentative cleanup of areas of interest on a given iText.Kernel.Pdf.PdfPage This method will add all redaction annotations to the given page, allowing the end-user to choose which redactions to keep or delete.

Parameters
pdfPage the page to clean up