iText.PdfCleanup.CleanUpProperties Class Reference

Contains properties for PdfCleanUpTool operations. More...

Public Member Functions
	CleanUpProperties ()
	Creates default CleanUpProperties instance. More...
virtual iText.PdfCleanup.CleanUpProperties	SetMetaInfo (IMetaInfo metaInfo)
	Sets additional meta info. More...
virtual bool	IsProcessAnnotations ()
	Check if page annotations will be processed. More...
virtual iText.PdfCleanup.CleanUpProperties	SetProcessAnnotations (bool processAnnotations)
	Set if page annotations will be processed. More...
virtual ? double	GetOverlapRatio ()
	Gets the overlap ratio. More...
virtual iText.PdfCleanup.CleanUpProperties	SetOverlapRatio (double? overlapRatio)
	Sets the overlap ratio. More...
virtual PathOffsetApproximationProperties	GetOffsetProperties ()
	Get PathOffsetApproximationProperties specifying approximation parameters for iText.Kernel.Pdf.Canvas.Parser.ClipperLib.ClipperOffset operations. More...
virtual iText.PdfCleanup.CleanUpProperties	SetOffsetProperties (PathOffsetApproximationProperties offsetProperties)
	Set PathOffsetApproximationProperties specifying approximation parameters for iText.Kernel.Pdf.Canvas.Parser.ClipperLib.ClipperOffset operations. More...

Detailed Description

Contains properties for PdfCleanUpTool operations.

Constructor & Destructor Documentation

CleanUpProperties()

iText.PdfCleanup.CleanUpProperties.CleanUpProperties ( )

inline

Creates default CleanUpProperties instance.

Member Function Documentation

GetOffsetProperties()

virtual PathOffsetApproximationProperties iText.PdfCleanup.CleanUpProperties.GetOffsetProperties ( )

inlinevirtual

Get PathOffsetApproximationProperties specifying approximation parameters for iText.Kernel.Pdf.Canvas.Parser.ClipperLib.ClipperOffset operations.

Returns

PathOffsetApproximationProperties parameters

GetOverlapRatio()

virtual ? double iText.PdfCleanup.CleanUpProperties.GetOverlapRatio ( )

inlinevirtual

Gets the overlap ratio.

Gets the overlap ratio. This is a value between 0 and 1 that indicates how much the content region should overlap with the redaction area to be removed.

Returns

the overlap ratio or null if it has not been set.

IsProcessAnnotations()

virtual bool iText.PdfCleanup.CleanUpProperties.IsProcessAnnotations ( )

inlinevirtual

Check if page annotations will be processed.

Check if page annotations will be processed. Default: true.

Returns

true if annotations will be processed by the PdfCleanUpTool

SetMetaInfo()

virtual iText.PdfCleanup.CleanUpProperties iText.PdfCleanup.CleanUpProperties.SetMetaInfo ( IMetaInfo  metaInfo )

inlinevirtual

Sets additional meta info.

Parameters

metaInfo

the meta info to set

Returns

this CleanUpProperties instance

SetOffsetProperties()

virtual iText.PdfCleanup.CleanUpProperties iText.PdfCleanup.CleanUpProperties.SetOffsetProperties ( PathOffsetApproximationProperties  offsetProperties )

inlinevirtual

Set PathOffsetApproximationProperties specifying approximation parameters for iText.Kernel.Pdf.Canvas.Parser.ClipperLib.ClipperOffset operations.

Parameters

offsetProperties

PathOffsetApproximationProperties to set

Returns

this CleanUpProperties instance

SetOverlapRatio()

virtual iText.PdfCleanup.CleanUpProperties iText.PdfCleanup.CleanUpProperties.SetOverlapRatio ( double?  overlapRatio )

inlinevirtual

Sets the overlap ratio.

Sets the overlap ratio. This is a value between 0 and 1 that indicates how much the content region should overlap with the redaction area to be removed.

Example: if the overlap ratio is set to 0.3, the content region will be removed if it overlaps with the redaction area by at least 30%.

Parameters

overlapRatio

the overlap ratio to set

Returns

this CleanUpProperties instance

SetProcessAnnotations()

virtual iText.PdfCleanup.CleanUpProperties iText.PdfCleanup.CleanUpProperties.SetProcessAnnotations ( bool  processAnnotations )

inlinevirtual

Set if page annotations will be processed.

Set if page annotations will be processed. Default processing behaviour: remove annotation if there is overlap with a redaction region.

Parameters

processAnnotations

is page annotations will be processed

Returns

this CleanUpProperties instance