An abstract class that will run through all necessary checks defined in the different PDF/A standards and levels. More...

Inheritance diagram for iText.Pdfa.Checker.PdfAChecker:

Public Member Functions
virtual void	CheckDocument (PdfCatalog catalog)
	This method checks a number of document-wide requirements of the PDF/A standard. More...

virtual void	ValidateDocument (ValidationContext validationContext)
	Validate the provided ValidationContext. More...

virtual void	ValidateObject (Object obj, IsoKey key, PdfResources resources, PdfStream contentStream, Object extra)
	Check the provided object for conformance. More...

virtual void	CheckSinglePage (PdfPage page)
	This method checks all requirements that must be fulfilled by a page in a PDF/A document. More...

virtual void	CheckPdfObject (PdfObject obj)
	This method checks the requirements that must be fulfilled by a COS object in a PDF/A document. More...

virtual PdfAConformanceLevel	GetConformanceLevel ()
	Gets the iText.Kernel.Pdf.PdfAConformanceLevel for this file. More...

virtual bool	IsFullCheckMode ()
	In full check mode all objects will be tested for ISO conformance. More...

virtual void	SetFullCheckMode (bool fullCheckMode)
	In full check mode all objects will be tested for ISO conformance. More...

virtual bool	ObjectIsChecked (PdfObject @object)
	Remembers which objects have already been checked, in order to avoid redundant checks. More...

virtual void	CheckTagStructureElement (PdfObject obj)
	This method checks compliance of the tag structure elements, such as struct elements or parent tree entries. More...

virtual void	CheckSignature (PdfDictionary signatureDict)
	This method checks compliance of the signature dictionary More...

virtual void	CheckSignatureType (bool isCAdES)
	This method checks compliance of the signature type More...

abstract void	CheckCanvasStack (char stackOperation)
	This method checks compliance with the graphics state architectural limitation, explained by maxGsStackDepth. More...

abstract void	CheckInlineImage (PdfStream inlineImage, PdfDictionary currentColorSpaces)
	This method checks compliance with the inline image restrictions in the PDF/A specs, specifically filter parameters. More...

abstract void	CheckColor (Color color, PdfDictionary currentColorSpaces, bool? fill, PdfStream contentStream)
	This method checks compliance with the color restrictions imposed by the available color spaces in the document. More...

virtual void	CheckColor (CanvasGraphicsState gState, Color color, PdfDictionary currentColorSpaces, bool? fill, PdfStream contentStream)
	This method checks compliance with the color restrictions imposed by the available color spaces in the document. More...

virtual void	CheckColorSpace (PdfColorSpace colorSpace, PdfObject pdfObject, PdfDictionary currentColorSpaces, bool checkAlternate, bool? fill)
	This method performs a range of checks on the given color space, depending on the type and properties of that color space. More...

virtual void	CheckColorSpace (PdfColorSpace colorSpace, PdfDictionary currentColorSpaces, bool checkAlternate, bool? fill)
	This method performs a range of checks on the given color space, depending on the type and properties of that color space. More...

virtual void	SetPdfAOutputIntentColorSpace (PdfDictionary catalog)
	Set Pdf A output intent color space. More...

abstract void	CheckRenderingIntent (PdfName intent)
	Checks whether the rendering intent of the document is within the allowed range of intents. More...

abstract void	CheckFontGlyphs (PdfFont font, PdfStream contentStream)
	Performs a check of the each font glyph as a Form XObject. More...

abstract void	CheckExtGState (CanvasGraphicsState extGState, PdfStream contentStream)
	Performs a number of checks on the graphics state, among others ISO 19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10. More...

abstract void	CheckFont (PdfFont pdfFont)
	Performs a number of checks on the font. More...

abstract void	CheckXrefTable (PdfXrefTable xrefTable)
	Verify the conformity of the cross-reference table. More...

virtual void	CheckCrypto (PdfObject crypto)
	Verify the conformity of encryption usage. More...

virtual void	CheckText (String text, PdfFont font)
	Verify the conformity of the text written by the specified font. More...

Static Public Attributes
const String	ICC_COLOR_SPACE_RGB = "RGB "
	The Red-Green-Blue color profile as defined by the International Color Consortium. More...

const String	ICC_COLOR_SPACE_CMYK = "CMYK"
	The Cyan-Magenta-Yellow-Key (black) color profile as defined by the International Color Consortium. More...

const String	ICC_COLOR_SPACE_GRAY = "GRAY"
	The Grayscale color profile as defined by the International Color Consortium. More...

const String	ICC_DEVICE_CLASS_OUTPUT_PROFILE = "prtr"
	The Output device class More...

const String	ICC_DEVICE_CLASS_MONITOR_PROFILE = "mntr"
	The Monitor device class More...

const int	maxGsStackDepth = 28
	The maximum Graphics State stack depth in PDF/A documents, i.e. the maximum number of graphics state operators with code `q` that may be opened (i.e. not yet closed by a corresponding `Q`) at any point in a content stream sequence. More...

Package Functions
	PdfAChecker (PdfAConformanceLevel conformanceLevel)
	Creates a PdfAChecker with the required conformance level. More...

abstract void	CheckContentStream (PdfStream contentStream)
	Attest content stream conformance with appropriate specification. More...

virtual void	CheckContentStreamObject (PdfObject @object)
	Verify the conformity of the operand of content stream with appropriate specification. More...

abstract long	GetMaxNumberOfIndirectObjects ()
	Retrieve maximum allowed number of indirect objects in conforming document. More...

abstract ICollection< PdfName >	GetForbiddenActions ()
	Retrieve forbidden actions in conforming document. More...

abstract ICollection< PdfName >	GetAllowedNamedActions ()
	Retrieve allowed actions in conforming document. More...

abstract void	CheckAction (PdfDictionary action)
	Checks if the action is allowed. More...

abstract void	CheckAnnotation (PdfDictionary annotDic)
	Verify the conformity of the annotation dictionary. More...

abstract void	CheckCatalogValidEntries (PdfDictionary catalogDict)
	Checks if entries in catalog dictionary are valid. More...

abstract void	CheckColorsUsages ()
	Verify the conformity of used color spaces. More...

virtual void	CheckPageColorsUsages (PdfDictionary pageDict, PdfDictionary pageResources)
	Verify the conformity of used color spaces on the page. More...

abstract void	CheckImage (PdfStream image, PdfDictionary currentColorSpaces)
	Verify the conformity of the given image. More...

abstract void	CheckFileSpec (PdfDictionary fileSpec)
	Verify the conformity of the file specification dictionary. More...

abstract void	CheckForm (PdfDictionary form)
	Verify the conformity of the form dictionary. More...

abstract void	CheckFormXObject (PdfStream form)
	Verify the conformity of the form XObject dictionary. More...

abstract void	CheckLogicalStructure (PdfDictionary catalog)
	Performs a number of checks on the logical structure of the document. More...

abstract void	CheckMetaData (PdfDictionary catalog)
	Performs a number of checks on the metadata of the document. More...

abstract void	CheckNonSymbolicTrueTypeFont (PdfTrueTypeFont trueTypeFont)
	Verify the conformity of the non-symbolic TrueType font. More...

abstract void	CheckOutputIntents (PdfDictionary catalogOrPageDict)
	Verify the conformity of the output intents array in the catalog dictionary. More...

abstract void	CheckPageObject (PdfDictionary page, PdfDictionary pageResources)
	Verify the conformity of the page dictionary. More...

abstract void	CheckPageSize (PdfDictionary page)
	Checks the allowable size of the page. More...

abstract void	CheckPdfArray (PdfArray array)
	Verify the conformity of the PDF array. More...

abstract void	CheckPdfDictionary (PdfDictionary dictionary)
	Verify the conformity of the PDF dictionary. More...

abstract void	CheckPdfName (PdfName name)
	Verify the conformity of the PDF name. More...

abstract void	CheckPdfNumber (PdfNumber number)
	Verify the conformity of the PDF number. More...

abstract void	CheckPdfStream (PdfStream stream)
	Verify the conformity of the PDF stream. More...

abstract void	CheckPdfString (PdfString @string)
	Verify the conformity of the PDF string. More...

abstract void	CheckSymbolicTrueTypeFont (PdfTrueTypeFont trueTypeFont)
	Verify the conformity of the symbolic TrueType font. More...

abstract void	CheckTrailer (PdfDictionary trailer)
	Verify the conformity of the trailer dictionary. More...

virtual void	CheckCatalog (PdfCatalog catalog)
	Verify the conformity of the pdf catalog. More...

abstract void	CheckPageTransparency (PdfDictionary pageDict, PdfDictionary pageResources)
	Verify the conformity of the page transparency. More...

virtual void	CheckResources (PdfDictionary resources)
	Verify the conformity of the resources dictionary. More...

virtual void	CheckResources (PdfDictionary resources, PdfObject pdfObject)
	Verify the conformity of the resources dictionary. More...

virtual bool	IsAlreadyChecked (PdfDictionary dictionary)
	Checks whether the specified dictionary was already checked. More...

virtual void	CheckResourcesOfAppearanceStreams (PdfDictionary appearanceStreamsDict)
	Checks resources of the appearance streams. More...

virtual void	CheckAppearanceStream (PdfStream appearanceStream)
	Check single annotation appearance stream. More...

Static Package Functions
static bool	CheckFlag (int flags, int flag)
	Checks if the specified flag is set. More...

static bool	CheckStructure (PdfAConformanceLevel conformanceLevel)
	Checks conformance level of PDF/A standard. More...

static bool	IsContainsTransparencyGroup (PdfDictionary dictionary)
	Checks whether the specified dictionary has a transparency group. More...

Package Attributes
PdfAConformanceLevel	conformanceLevel

PdfStream	pdfAOutputIntentDestProfile

String	pdfAOutputIntentColorSpace

int	gsStackDepth = 0

bool	rgbIsUsed = false

bool	cmykIsUsed = false

bool	grayIsUsed = false

ICollection< PdfObject >	rgbUsedObjects = new HashSet<PdfObject>()

ICollection< PdfObject >	cmykUsedObjects = new HashSet<PdfObject>()

ICollection< PdfObject >	grayUsedObjects = new HashSet<PdfObject>()

ICollection< PdfObject >	checkedObjects = new HashSet<PdfObject>()
	Contains some objects that are already checked. More...

IDictionary< PdfObject, PdfColorSpace >	checkedObjectsColorspace

Detailed Description

An abstract class that will run through all necessary checks defined in the different PDF/A standards and levels.

An abstract class that will run through all necessary checks defined in the different PDF/A standards and levels. A number of common checks are executed in this class, while standard-dependent specifications are implemented in the available subclasses. The standard that is followed is the series of ISO 19005 specifications, currently generations 1 through 3. The ZUGFeRD standard is derived from ISO 19005-3. While it is possible to subclass this method and implement its abstract methods in client code, this is not encouraged and will have little effect. It is not possible to plug custom implementations into iText, because iText should always refuse to create non-compliant PDF/A, which would be possible with client code implementations. Any future generations of the PDF/A standard and its derivates will get their own implementation in the iText - pdfa project.

Constructor & Destructor Documentation

◆ PdfAChecker()

iText.Pdfa.Checker.PdfAChecker.PdfAChecker ( PdfAConformanceLevel conformanceLevel )

inlinepackage

Creates a PdfAChecker with the required conformance level.

Parameters

conformanceLevel the required conformance level

Member Function Documentation

◆ CheckAction()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckAction ( PdfDictionary action )

packagepure virtual

Checks if the action is allowed.

Parameters

action to be checked

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckAnnotation()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckAnnotation ( PdfDictionary annotDic )

packagepure virtual

Verify the conformity of the annotation dictionary.

Parameters

annotDic the annotation iText.Kernel.Pdf.PdfDictionary to be checked

Implemented in iText.Pdfa.Checker.PdfA1Checker, iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckAppearanceStream()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckAppearanceStream ( PdfStream appearanceStream )

inlinepackagevirtual

Check single annotation appearance stream.

Parameters

appearanceStream the iText.Kernel.Pdf.PdfStream to check

Reimplemented in iText.Pdfa.Checker.PdfA2Checker.

◆ CheckCanvasStack()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckCanvasStack ( char stackOperation )

pure virtual

This method checks compliance with the graphics state architectural limitation, explained by maxGsStackDepth.

Parameters

stackOperation the operation to check the graphics state counter for

Implemented in iText.Pdfa.Checker.PdfA4Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckCatalog()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckCatalog ( PdfCatalog catalog )

inlinepackagevirtual

Verify the conformity of the pdf catalog.

Parameters

catalog the iText.Kernel.Pdf.PdfCatalog of trailer to check.

Reimplemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckCatalogValidEntries()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckCatalogValidEntries ( PdfDictionary catalogDict )

packagepure virtual

Checks if entries in catalog dictionary are valid.

Parameters

catalogDict the catalog iText.Kernel.Pdf.PdfDictionary to be checked

Implemented in iText.Pdfa.Checker.PdfA1Checker, iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckColor() [1/2]

virtual void iText.Pdfa.Checker.PdfAChecker.CheckColor	(	CanvasGraphicsState	gState,
		Color	color,
		PdfDictionary	currentColorSpaces,
		bool?	fill,
		PdfStream	contentStream
	)

inlinevirtual

This method checks compliance with the color restrictions imposed by the available color spaces in the document.

Parameters

gState	canvas graphics state
color	the color to check
currentColorSpaces	a iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document
fill	whether the color is used for fill or stroke operations
contentStream	current content stream

Reimplemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckColor() [2/2]

abstract void iText.Pdfa.Checker.PdfAChecker.CheckColor	(	Color	color,
		PdfDictionary	currentColorSpaces,
		bool?	fill,
		PdfStream	contentStream
	)

pure virtual

This method checks compliance with the color restrictions imposed by the available color spaces in the document.

This method checks compliance with the color restrictions imposed by the available color spaces in the document. This method will be abstract in update 7.2

Parameters

color	the color to check
currentColorSpaces	a iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document
fill	whether the color is used for fill or stroke operations
contentStream	current content stream

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA2Checker.

◆ CheckColorSpace() [1/2]

virtual void iText.Pdfa.Checker.PdfAChecker.CheckColorSpace	(	PdfColorSpace	colorSpace,
		PdfDictionary	currentColorSpaces,
		bool	checkAlternate,
		bool?	fill
	)

inlinevirtual

This method performs a range of checks on the given color space, depending on the type and properties of that color space.

Parameters

colorSpace	the color space to check
currentColorSpaces	a iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document
checkAlternate	whether or not to also check the parent color space
fill	whether the color space is used for fill or stroke operations

◆ CheckColorSpace() [2/2]

virtual void iText.Pdfa.Checker.PdfAChecker.CheckColorSpace	(	PdfColorSpace	colorSpace,
		PdfObject	pdfObject,
		PdfDictionary	currentColorSpaces,
		bool	checkAlternate,
		bool?	fill
	)

inlinevirtual

This method performs a range of checks on the given color space, depending on the type and properties of that color space.

Parameters

colorSpace	the color space to check
pdfObject	the pdf object to check color space in
currentColorSpaces	a iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document
checkAlternate	whether or not to also check the parent color space
fill	whether the color space is used for fill or stroke operations

Reimplemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckColorsUsages()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckColorsUsages ( )

packagepure virtual

Verify the conformity of used color spaces.

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckContentStream()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckContentStream ( PdfStream contentStream )

packagepure virtual

Attest content stream conformance with appropriate specification.

Attest content stream conformance with appropriate specification. Throws PdfAConformanceException if any discrepancy was found

Parameters

contentStream is a content stream to validate

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckContentStreamObject()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckContentStreamObject ( PdfObject @ object )

inlinepackagevirtual

Verify the conformity of the operand of content stream with appropriate specification.

Verify the conformity of the operand of content stream with appropriate specification. Throws PdfAConformanceException if any discrepancy was found

Parameters

object is an operand of content stream to validate

◆ CheckCrypto()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckCrypto ( PdfObject crypto )

inlinevirtual

Verify the conformity of encryption usage.

Parameters

crypto Encryption object to verify.

Reimplemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckDocument()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckDocument ( PdfCatalog catalog )

inlinevirtual

This method checks a number of document-wide requirements of the PDF/A standard.

This method checks a number of document-wide requirements of the PDF/A standard. The algorithms of some of these checks vary with the PDF/A level and thus are implemented in subclasses; others are implemented as private methods in this class.

Parameters

catalog The catalog being checked

◆ CheckExtGState()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckExtGState	(	CanvasGraphicsState	extGState,
		PdfStream	contentStream
	)

pure virtual

Performs a number of checks on the graphics state, among others ISO 19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10.

Performs a number of checks on the graphics state, among others ISO 19005-1 section 6.2.8 and 6.4 and ISO 19005-2 section 6.2.5 and 6.2.10. This method will be abstract in the update 7.2

Parameters

extGState	the graphics state to be checked
contentStream	current content stream

Implemented in iText.Pdfa.Checker.PdfA4Checker, iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckFileSpec()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckFileSpec ( PdfDictionary fileSpec )

packagepure virtual

Verify the conformity of the file specification dictionary.

Parameters

fileSpec the iText.Kernel.Pdf.PdfDictionary containing file specification to be checked

Implemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA1Checker, iText.Pdfa.Checker.PdfA4Checker, and iText.Pdfa.Checker.PdfA3Checker.

◆ CheckFlag()

static bool iText.Pdfa.Checker.PdfAChecker.CheckFlag	(	int	flags,
		int	flag
	)

inlinestaticpackage

Checks if the specified flag is set.

Parameters

flags	a set of flags specifying various characteristics of the PDF object
flag	to be checked

Returns: true if the specified flag is set

◆ CheckFont()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckFont ( PdfFont pdfFont )

pure virtual

Performs a number of checks on the font.

Performs a number of checks on the font. See ISO 19005-1 section 6.3, ISO 19005-2 and ISO 19005-3 section 6.2.11. Be aware that not all constraints defined in the ISO are checked in this method, for most of them we consider that iText always creates valid fonts.

Parameters

pdfFont font to be checked

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckFontGlyphs()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckFontGlyphs	(	PdfFont	font,
		PdfStream	contentStream
	)

pure virtual

Performs a check of the each font glyph as a Form XObject.

Performs a check of the each font glyph as a Form XObject. See ISO 19005-2 Annex A.5. This only applies to type 3 fonts. This method will be abstract in update 7.2

Parameters

font

iText.Kernel.Font.PdfFont to be checked

Parameters

contentStream stream containing checked font

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckForm()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckForm ( PdfDictionary form )

packagepure virtual

Verify the conformity of the form dictionary.

Parameters

form	the form iText.Kernel.Pdf.PdfDictionary to be checked

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA2Checker.

◆ CheckFormXObject()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckFormXObject ( PdfStream form )

packagepure virtual

Verify the conformity of the form XObject dictionary.

Parameters

form	the iText.Kernel.Pdf.PdfStream to check

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckImage()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckImage	(	PdfStream	image,
		PdfDictionary	currentColorSpaces
	)

packagepure virtual

Verify the conformity of the given image.

Parameters

image	the image to check
currentColorSpaces	the iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckInlineImage()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckInlineImage	(	PdfStream	inlineImage,
		PdfDictionary	currentColorSpaces
	)

pure virtual

This method checks compliance with the inline image restrictions in the PDF/A specs, specifically filter parameters.

Parameters

inlineImage	a iText.Kernel.Pdf.PdfStream containing the inline image
currentColorSpaces	a iText.Kernel.Pdf.PdfDictionary containing the color spaces used in the document

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckLogicalStructure()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckLogicalStructure ( PdfDictionary catalog )

packagepure virtual

Performs a number of checks on the logical structure of the document.

Parameters

catalog the catalog iText.Kernel.Pdf.PdfDictionary to check

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckMetaData()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckMetaData ( PdfDictionary catalog )

packagepure virtual

Performs a number of checks on the metadata of the document.

Parameters

catalog the catalog iText.Kernel.Pdf.PdfDictionary to check

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckNonSymbolicTrueTypeFont()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckNonSymbolicTrueTypeFont ( PdfTrueTypeFont trueTypeFont )

packagepure virtual

Verify the conformity of the non-symbolic TrueType font.

Parameters

trueTypeFont the iText.Kernel.Font.PdfTrueTypeFont to check

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckOutputIntents()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckOutputIntents ( PdfDictionary catalogOrPageDict )

packagepure virtual

Verify the conformity of the output intents array in the catalog dictionary.

Parameters

catalogOrPageDict the iText.Kernel.Pdf.PdfDictionary of a catalog or page to check

Implemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckPageColorsUsages()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckPageColorsUsages	(	PdfDictionary	pageDict,
		PdfDictionary	pageResources
	)

inlinepackagevirtual

Verify the conformity of used color spaces on the page.

Parameters

pageDict	the iText.Kernel.Pdf.PdfDictionary contains contents for colors to be checked.
pageResources	the iText.Kernel.Pdf.PdfDictionary contains resources for colors to be checked.

Reimplemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckPageObject()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPageObject	(	PdfDictionary	page,
		PdfDictionary	pageResources
	)

packagepure virtual

Verify the conformity of the page dictionary.

Parameters

page	the iText.Kernel.Pdf.PdfDictionary to check
pageResources	the page's resources dictionary

Implemented in iText.Pdfa.Checker.PdfA1Checker, iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckPageSize()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPageSize ( PdfDictionary page )

packagepure virtual

Checks the allowable size of the page.

Parameters

page	the iText.Kernel.Pdf.PdfDictionary of page which size being checked

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckPageTransparency()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPageTransparency	(	PdfDictionary	pageDict,
		PdfDictionary	pageResources
	)

packagepure virtual

Verify the conformity of the page transparency.

Parameters

pageDict	the iText.Kernel.Pdf.PdfDictionary contains contents for transparency to be checked
pageResources	the iText.Kernel.Pdf.PdfDictionary contains resources for transparency to be checked

Implemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckPdfArray()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfArray ( PdfArray array )

packagepure virtual

Verify the conformity of the PDF array.

Parameters

array the iText.Kernel.Pdf.PdfArray to check

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA2Checker.

◆ CheckPdfDictionary()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfDictionary ( PdfDictionary dictionary )

packagepure virtual

Verify the conformity of the PDF dictionary.

Parameters

dictionary the iText.Kernel.Pdf.PdfDictionary to check

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA2Checker.

◆ CheckPdfName()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfName ( PdfName name )

packagepure virtual

Verify the conformity of the PDF name.

Parameters

name	the iText.Kernel.Pdf.PdfName to check

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckPdfNumber()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfNumber ( PdfNumber number )

packagepure virtual

Verify the conformity of the PDF number.

Parameters

number the iText.Kernel.Pdf.PdfNumber to check

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckPdfObject()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckPdfObject ( PdfObject obj )

inlinevirtual

This method checks the requirements that must be fulfilled by a COS object in a PDF/A document.

Parameters

obj	the COS object that must be checked

◆ CheckPdfStream()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfStream ( PdfStream stream )

packagepure virtual

Verify the conformity of the PDF stream.

Parameters

stream the iText.Kernel.Pdf.PdfStream to check

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ CheckPdfString()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckPdfString ( PdfString @ string )

packagepure virtual

Verify the conformity of the PDF string.

Parameters

string the iText.Kernel.Pdf.PdfString to check

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckRenderingIntent()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckRenderingIntent ( PdfName intent )

pure virtual

Checks whether the rendering intent of the document is within the allowed range of intents.

Checks whether the rendering intent of the document is within the allowed range of intents. This is defined in ISO 19005-1 section 6.2.9, and unchanged in newer generations of the PDF/A specification.

Parameters

intent the intent to be analyzed

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckResources() [1/2]

virtual void iText.Pdfa.Checker.PdfAChecker.CheckResources ( PdfDictionary resources )

inlinepackagevirtual

Verify the conformity of the resources dictionary.

Parameters

resources the iText.Kernel.Pdf.PdfDictionary to be checked

◆ CheckResources() [2/2]

virtual void iText.Pdfa.Checker.PdfAChecker.CheckResources	(	PdfDictionary	resources,
		PdfObject	pdfObject
	)

inlinepackagevirtual

Verify the conformity of the resources dictionary.

Parameters

resources	the iText.Kernel.Pdf.PdfDictionary to be checked
pdfObject	the pdf object to check resources for

◆ CheckResourcesOfAppearanceStreams()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckResourcesOfAppearanceStreams ( PdfDictionary appearanceStreamsDict )

inlinepackagevirtual

Checks resources of the appearance streams.

Parameters

appearanceStreamsDict the dictionary with appearance streams to check.

◆ CheckSignature()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckSignature ( PdfDictionary signatureDict )

inlinevirtual

This method checks compliance of the signature dictionary

Parameters

signatureDict a iText.Kernel.Pdf.PdfDictionary containing the signature.

Reimplemented in iText.Pdfa.Checker.PdfA2Checker.

◆ CheckSignatureType()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckSignatureType ( bool isCAdES )

inlinevirtual

This method checks compliance of the signature type

Parameters

isCAdES true is CAdES sig type is used, false otherwise.

Reimplemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckSinglePage()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckSinglePage ( PdfPage page )

inlinevirtual

This method checks all requirements that must be fulfilled by a page in a PDF/A document.

Parameters

page	the page that must be checked

◆ CheckStructure()

static bool iText.Pdfa.Checker.PdfAChecker.CheckStructure ( PdfAConformanceLevel conformanceLevel )

inlinestaticpackage

Checks conformance level of PDF/A standard.

Parameters

conformanceLevel the iText.Kernel.Pdf.PdfAConformanceLevel to be checked

Returns: true if the specified conformanceLevel is a for PDF/A-1, PDF/A-2 or PDF/A-3

◆ CheckSymbolicTrueTypeFont()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckSymbolicTrueTypeFont ( PdfTrueTypeFont trueTypeFont )

packagepure virtual

Verify the conformity of the symbolic TrueType font.

Parameters

trueTypeFont the iText.Kernel.Font.PdfTrueTypeFont to check

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckTagStructureElement()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckTagStructureElement ( PdfObject obj )

inlinevirtual

This method checks compliance of the tag structure elements, such as struct elements or parent tree entries.

Parameters

obj	an object that represents tag structure element.

◆ CheckText()

virtual void iText.Pdfa.Checker.PdfAChecker.CheckText	(	String	text,
		PdfFont	font
	)

inlinevirtual

Verify the conformity of the text written by the specified font.

Parameters

text	Text to verify.
font	Font to verify the text against.

Reimplemented in iText.Pdfa.Checker.PdfA1Checker.

◆ CheckTrailer()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckTrailer ( PdfDictionary trailer )

packagepure virtual

Verify the conformity of the trailer dictionary.

Parameters

trailer the iText.Kernel.Pdf.PdfDictionary of trailer to check

Implemented in iText.Pdfa.Checker.PdfA1Checker, and iText.Pdfa.Checker.PdfA4Checker.

◆ CheckXrefTable()

abstract void iText.Pdfa.Checker.PdfAChecker.CheckXrefTable ( PdfXrefTable xrefTable )

pure virtual

Verify the conformity of the cross-reference table.

Parameters

xrefTable is the Xref table

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ GetAllowedNamedActions()

abstract ICollection<PdfName> iText.Pdfa.Checker.PdfAChecker.GetAllowedNamedActions ( )

packagepure virtual

Retrieve allowed actions in conforming document.

Returns: set of iText.Kernel.Pdf.PdfName with allowed named actions

Implemented in iText.Pdfa.Checker.PdfA2Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ GetConformanceLevel()

virtual PdfAConformanceLevel iText.Pdfa.Checker.PdfAChecker.GetConformanceLevel ( )

inlinevirtual

Gets the iText.Kernel.Pdf.PdfAConformanceLevel for this file.

Returns: the defined conformance level for this document.

◆ GetForbiddenActions()

abstract ICollection<PdfName> iText.Pdfa.Checker.PdfAChecker.GetForbiddenActions ( )

packagepure virtual

Retrieve forbidden actions in conforming document.

Returns: set of iText.Kernel.Pdf.PdfName with forbidden actions

Implemented in iText.Pdfa.Checker.PdfA2Checker, iText.Pdfa.Checker.PdfA4Checker, and iText.Pdfa.Checker.PdfA1Checker.

◆ GetMaxNumberOfIndirectObjects()

abstract long iText.Pdfa.Checker.PdfAChecker.GetMaxNumberOfIndirectObjects ( )

packagepure virtual

Retrieve maximum allowed number of indirect objects in conforming document.

Returns: maximum allowed number of indirect objects

Implemented in iText.Pdfa.Checker.PdfA1Checker.

◆ IsAlreadyChecked()

virtual bool iText.Pdfa.Checker.PdfAChecker.IsAlreadyChecked ( PdfDictionary dictionary )

inlinepackagevirtual

Checks whether the specified dictionary was already checked.

Parameters

dictionary the iText.Kernel.Pdf.PdfDictionary to check

Returns: true if the specified dictionary was checked

◆ IsContainsTransparencyGroup()

static bool iText.Pdfa.Checker.PdfAChecker.IsContainsTransparencyGroup ( PdfDictionary dictionary )

inlinestaticpackage

Checks whether the specified dictionary has a transparency group.

Parameters

dictionary the iText.Kernel.Pdf.PdfDictionary to check

Returns: true if and only if the specified dictionary has a iText.Kernel.Pdf.PdfName.Group key and its value is a dictionary with iText.Kernel.Pdf.PdfName.Transparency subtype

◆ IsFullCheckMode()

virtual bool iText.Pdfa.Checker.PdfAChecker.IsFullCheckMode ( )

inlinevirtual

In full check mode all objects will be tested for ISO conformance.

In full check mode all objects will be tested for ISO conformance. If full check mode is switched off objects which were not modified might be skipped to speed up the validation of the document

Returns: true if full check mode is switched on

See also: iText.Kernel.Pdf.PdfObject.IsModified()

◆ ObjectIsChecked()

virtual bool iText.Pdfa.Checker.PdfAChecker.ObjectIsChecked ( PdfObject @ object )

inlinevirtual

Remembers which objects have already been checked, in order to avoid redundant checks.

Parameters

object the object to check

Returns: whether or not the object has already been checked

◆ SetFullCheckMode()

virtual void iText.Pdfa.Checker.PdfAChecker.SetFullCheckMode ( bool fullCheckMode )

inlinevirtual

In full check mode all objects will be tested for ISO conformance.

In full check mode all objects will be tested for ISO conformance. If full check mode is switched off objects which were not modified might be skipped to speed up the validation of the document

Parameters

fullCheckMode is a new value for full check mode switcher

See also: iText.Kernel.Pdf.PdfObject.IsModified()

◆ SetPdfAOutputIntentColorSpace()

virtual void iText.Pdfa.Checker.PdfAChecker.SetPdfAOutputIntentColorSpace ( PdfDictionary catalog )

inlinevirtual

Set Pdf A output intent color space.

Parameters

catalog Catalog dictionary to retrieve the color space from.

◆ ValidateDocument()

virtual void iText.Pdfa.Checker.PdfAChecker.ValidateDocument ( ValidationContext validationContext )

inlinevirtual

Validate the provided ValidationContext.

This method is called by the iText.Kernel.Pdf.PdfDocument.Close() to check for additional conformance requirements.

Parameters

validationContext the ValidationContext to validate

Implements iText.Kernel.Utils.IValidationChecker.

◆ ValidateObject()

virtual void iText.Pdfa.Checker.PdfAChecker.ValidateObject	(	Object	obj,
		IsoKey	key,
		PdfResources	resources,
		PdfStream	contentStream,
		Object	extra
	)

inlinevirtual

Check the provided object for conformance.

This method is called by the iText.Kernel.Pdf.PdfDocument.CheckIsoConformance(System.Object, iText.Kernel.Pdf.IsoKey, iText.Kernel.Pdf.PdfResources, iText.Kernel.Pdf.PdfStream, System.Object) to check for additional conformance requirements.

Parameters

obj	the object to check
key	the iText.Kernel.Pdf.IsoKey of the object
resources	the iText.Kernel.Pdf.PdfResources of the object
contentStream	the iText.Kernel.Pdf.PdfStream of the object
extra	additional information

Implements iText.Kernel.Utils.IValidationChecker.

Member Data Documentation

◆ checkedObjects

ICollection<PdfObject> iText.Pdfa.Checker.PdfAChecker.checkedObjects = new HashSet<PdfObject>()

package

Contains some objects that are already checked.

Contains some objects that are already checked. NOTE: Not all objects that were checked are stored in that set. This set is used for avoiding double checks for actions, signatures, xObjects and page objects; and for letting those objects to be manually flushed. Use this mechanism carefully: objects that are able to be changed (or at least if object's properties that shall be checked are able to be changed) shouldn't be marked as checked if they are not to be flushed immediately.

◆ checkedObjectsColorspace

IDictionary<PdfObject, PdfColorSpace> iText.Pdfa.Checker.PdfAChecker.checkedObjectsColorspace

package

Initial value:

= new Dictionary

, PdfColorSpace>()

◆ ICC_COLOR_SPACE_CMYK

const String iText.Pdfa.Checker.PdfAChecker.ICC_COLOR_SPACE_CMYK = "CMYK"

static

The Cyan-Magenta-Yellow-Key (black) color profile as defined by the International Color Consortium.

◆ ICC_COLOR_SPACE_GRAY

const String iText.Pdfa.Checker.PdfAChecker.ICC_COLOR_SPACE_GRAY = "GRAY"

static

The Grayscale color profile as defined by the International Color Consortium.

◆ ICC_COLOR_SPACE_RGB

const String iText.Pdfa.Checker.PdfAChecker.ICC_COLOR_SPACE_RGB = "RGB "

static

The Red-Green-Blue color profile as defined by the International Color Consortium.

◆ ICC_DEVICE_CLASS_MONITOR_PROFILE

const String iText.Pdfa.Checker.PdfAChecker.ICC_DEVICE_CLASS_MONITOR_PROFILE = "mntr"

static

The Monitor device class

◆ ICC_DEVICE_CLASS_OUTPUT_PROFILE

const String iText.Pdfa.Checker.PdfAChecker.ICC_DEVICE_CLASS_OUTPUT_PROFILE = "prtr"

static

The Output device class

◆ maxGsStackDepth

const int iText.Pdfa.Checker.PdfAChecker.maxGsStackDepth = 28

static

The maximum Graphics State stack depth in PDF/A documents, i.e. the maximum number of graphics state operators with code q that may be opened (i.e. not yet closed by a corresponding Q) at any point in a content stream sequence.

The maximum Graphics State stack depth in PDF/A documents, i.e. the maximum number of graphics state operators with code q that may be opened (i.e. not yet closed by a corresponding Q) at any point in a content stream sequence. Defined as 28 by PDF/A-1 section 6.1.12, by referring to the PDF spec Appendix C table 1 "architectural limits".

Public Member Functions

Static Public Attributes

Package Functions

Static Package Functions

Package Attributes

Detailed Description

Constructor & Destructor Documentation

◆ PdfAChecker()

Member Function Documentation

◆ CheckAction()

◆ CheckAnnotation()

◆ CheckAppearanceStream()

◆ CheckCanvasStack()

◆ CheckCatalog()

◆ CheckCatalogValidEntries()

◆ CheckColor() [1/2]

◆ CheckColor() [2/2]

◆ CheckColorSpace() [1/2]

◆ CheckColorSpace() [2/2]

◆ CheckColorsUsages()

◆ CheckContentStream()

◆ CheckContentStreamObject()

◆ CheckCrypto()

◆ CheckDocument()

◆ CheckExtGState()

◆ CheckFileSpec()

◆ CheckFlag()

◆ CheckFont()

◆ CheckFontGlyphs()

◆ CheckForm()

◆ CheckFormXObject()

◆ CheckImage()

◆ CheckInlineImage()

◆ CheckLogicalStructure()

◆ CheckMetaData()

◆ CheckNonSymbolicTrueTypeFont()

◆ CheckOutputIntents()

◆ CheckPageColorsUsages()

◆ CheckPageObject()

◆ CheckPageSize()

◆ CheckPageTransparency()

◆ CheckPdfArray()

◆ CheckPdfDictionary()

◆ CheckPdfName()

◆ CheckPdfNumber()

◆ CheckPdfObject()

◆ CheckPdfStream()

◆ CheckPdfString()

◆ CheckRenderingIntent()

◆ CheckResources() [1/2]

◆ CheckResources() [2/2]

◆ CheckResourcesOfAppearanceStreams()

◆ CheckSignature()

◆ CheckSignatureType()

◆ CheckSinglePage()

◆ CheckStructure()

◆ CheckSymbolicTrueTypeFont()

◆ CheckTagStructureElement()

◆ CheckText()

◆ CheckTrailer()

◆ CheckXrefTable()

◆ GetAllowedNamedActions()

◆ GetConformanceLevel()

◆ GetForbiddenActions()

◆ GetMaxNumberOfIndirectObjects()

◆ IsAlreadyChecked()

◆ IsContainsTransparencyGroup()

◆ IsFullCheckMode()

◆ ObjectIsChecked()

◆ SetFullCheckMode()

◆ SetPdfAOutputIntentColorSpace()

◆ ValidateDocument()

◆ ValidateObject()

Member Data Documentation

◆ checkedObjects

◆ checkedObjectsColorspace

◆ ICC_COLOR_SPACE_CMYK

◆ ICC_COLOR_SPACE_GRAY

◆ ICC_COLOR_SPACE_RGB

◆ ICC_DEVICE_CLASS_MONITOR_PROFILE