iText.PdfCleanup.PdfCleanUpLocation Class Reference

Defines the region to be erased in a PDF document. More...

Public Member Functions
	PdfCleanUpLocation (int page, Rectangle region)
	Constructs a PdfCleanUpLocation object. More...
	PdfCleanUpLocation (int page, Rectangle region, Color cleanUpColor)
	Constructs a PdfCleanUpLocation object. More...
virtual int	GetPage ()
	Returns the number of the page which the region belongs to.
virtual Rectangle	GetRegion ()
virtual Color	GetCleanUpColor ()
	Returns a color used to fill the area after erasing it. More...

Detailed Description

Defines the region to be erased in a PDF document.

Constructor & Destructor Documentation

PdfCleanUpLocation() [1/2]

iText.PdfCleanup.PdfCleanUpLocation.PdfCleanUpLocation ( int  page, Rectangle  region  )

inline

Constructs a PdfCleanUpLocation object.

Parameters

page	specifies the number of the page which the region belongs to.
region	represents the boundaries of the area to be erased.

PdfCleanUpLocation() [2/2]

iText.PdfCleanup.PdfCleanUpLocation.PdfCleanUpLocation ( int  page, Rectangle  region, Color  cleanUpColor  )

inline

Constructs a PdfCleanUpLocation object.

Parameters

page	specifies the number of the page which the region belongs to.
region	represents the boundaries of the area to be erased.
cleanUpColor	a color used to fill the area after erasing it. If null the erased area left uncolored.

Member Function Documentation

GetCleanUpColor()

virtual Color iText.PdfCleanup.PdfCleanUpLocation.GetCleanUpColor ( )

inlinevirtual

Returns a color used to fill the area after erasing it.

Returns a color used to fill the area after erasing it. If null the erased area left uncolored.

Returns

a color used to fill the area after erasing it.

GetRegion()

virtual Rectangle iText.PdfCleanup.PdfCleanUpLocation.GetRegion ( )

inlinevirtual

Returns

A iText.Kernel.Geom.Rectangle representing the boundaries of the area to be erased.