iText 9.7.0 API
iText.Kernel.Pdf.PdfConformance Class Reference

The class represents possible PDF document conformance. More...

Public Member Functions

  PdfConformance (PdfAConformance aConformance, PdfUAConformance uaConformance, WellTaggedPdfConformance wtpdfConformance)
  Creates a new PdfConformance instance based on PDF/A, PDF/UA and Well Tagged PDF conformance. More...
 
  PdfConformance (PdfAConformance aConformance, PdfUAConformance uaConformance, IList< WellTaggedPdfConformance > wtpdfConformanceList)
  Creates a new PdfConformance instance based on PDF/A, PDF/UA and Well Tagged PDF conformance. More...
 
  PdfConformance (PdfAConformance aConformance, PdfUAConformance uaConformance)
  Creates a new PdfConformance instance based on PDF/A and PDF/UA conformance. More...
 
  PdfConformance (PdfAConformance aConformance)
  Creates a new PdfConformance instance based on only PDF/A conformance. More...
 
  PdfConformance (PdfUAConformance uaConformance)
  Creates a new PdfConformance instance based on only PDF/UA conformance. More...
 
  PdfConformance (IList< WellTaggedPdfConformance > wtpdfConformance)
  Creates a new PdfConformance instance based on only Well Tagged PDF conformance. More...
 
  PdfConformance (WellTaggedPdfConformance wtpdfConformance)
  Creates a new PdfConformance instance based on only Well Tagged PDF conformance. More...
 
  PdfConformance ()
  Creates a new PdfConformance instance without any conformance. More...
 
virtual void  SetConformanceToXmp (XMPMeta xmpMeta)
  Sets required fields into XMP metadata according to passed PDF conformance. More...
 
virtual bool  IsPdfA ()
  Checks if any PDF/A conformance is specified. More...
 
virtual bool  IsPdfUA ()
  Checks if any PDF/UA conformance is specified. More...
 
virtual bool  IsWtpdf ()
  Checks if any Well Tagged PDF conformance is specified. More...
 
virtual bool  ConformsToAny ()
  Checks if any of PDF/A, PDF/UA or Well Tagged PDF conformance is specified More...
 
virtual PdfAConformance  GetAConformance ()
  Gets the PdfAConformance instance if specified. More...
 
virtual PdfUAConformance  GetUAConformance ()
  Gets the PdfUAConformance instance if specified. More...
 
virtual IList< WellTaggedPdfConformance GetWtpdfConformances ()
  Gets the list of WellTaggedPdfConformance instances if specified. More...
 
virtual bool  ConformsTo (WellTaggedPdfConformance wtPdfConformance)
  Gets the WellTaggedPdfConformance instance if specified. More...
 
virtual bool  ConformsTo (PdfUAConformance uaConformance)
  Checks if specified PDF/UA conformance is present in this PdfConformance instance. More...
 
virtual bool  ConformsTo (PdfAConformance aConformance)
  Checks if specified PDF/A conformance is present in this PdfConformance instance. More...
 
virtual bool  ConformsTo (params iText.Kernel.Pdf.PdfConformance[] conformanceList)
  Checks if any of specified conformance is present in this PdfConformance instance. More...
 
virtual bool  Includes (iText.Kernel.Pdf.PdfConformance conformance)
  Checks if passed conformance is fully included into this PdfConformance More...
 
virtual bool  IsWellTaggedConformanceIncluded (iText.Kernel.Pdf.PdfConformance conformance)
  Checks if well tagged conformance part of passed conformance is included into this PdfConformance More...
 
virtual bool  IsPdfAOrUa ()
  Checks if any PDF/A or PDF/UA conformance is specified. More...
 
override int  GetHashCode ()
 
override bool  Equals (Object o)
 
override String  ToString ()
 

Static Public Member Functions

static iText.Kernel.Pdf.PdfConformance  GetConformance (XMPMeta meta)
  Gets PdfConformance instance from iText.Kernel.XMP.XMPMeta. More...
 
static void  SetConformanceToXmp (XMPMeta xmpMeta, iText.Kernel.Pdf.PdfConformance conformance)
  Sets required fields into XMP metadata according to passed PDF conformance. More...
 
static PdfAConformance  GetAConformance (String part, String level)
  Gets an instance of PdfAConformance based on passed part and level. More...
 

Static Public Attributes

const String  PDF_A_4_REVISION = "2020"
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_1A
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_1B
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_2A
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_2B
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_2U
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_3A
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_3B
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_3U
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_4
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_4E
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_A_4F
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_UA_1
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_UA_2
 
static readonly iText.Kernel.Pdf.PdfConformance  WELL_TAGGED_PDF_FOR_ACCESSIBILITY
 
static readonly iText.Kernel.Pdf.PdfConformance  WELL_TAGGED_PDF_FOR_REUSE
 
static readonly iText.Kernel.Pdf.PdfConformance  PDF_NONE_CONFORMANCE
 

Detailed Description

The class represents possible PDF document conformance.

Constructor & Destructor Documentation

◆ PdfConformance() [1/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( PdfAConformance  aConformance,
PdfUAConformance  uaConformance,
WellTaggedPdfConformance  wtpdfConformance 
)
inline

Creates a new PdfConformance instance based on PDF/A, PDF/UA and Well Tagged PDF conformance.

Parameters
aConformance the PDF/A conformance
uaConformance the PDF/UA conformance
wtpdfConformance the Well Tagged PDF conformance

◆ PdfConformance() [2/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( PdfAConformance  aConformance,
PdfUAConformance  uaConformance,
IList< WellTaggedPdfConformance wtpdfConformanceList 
)
inline

Creates a new PdfConformance instance based on PDF/A, PDF/UA and Well Tagged PDF conformance.

Parameters
aConformance the PDF/A conformance
uaConformance the PDF/UA conformance
wtpdfConformanceList the Well Tagged PDF conformance

◆ PdfConformance() [3/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( PdfAConformance  aConformance,
PdfUAConformance  uaConformance 
)
inline

Creates a new PdfConformance instance based on PDF/A and PDF/UA conformance.

Parameters
aConformance the PDF/A conformance
uaConformance the PDF/UA conformance

◆ PdfConformance() [4/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( PdfAConformance  aConformance )
inline

Creates a new PdfConformance instance based on only PDF/A conformance.

Parameters
aConformance the PDF/A conformance

◆ PdfConformance() [5/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( PdfUAConformance  uaConformance )
inline

Creates a new PdfConformance instance based on only PDF/UA conformance.

Parameters
uaConformance the PDF/UA conformance

◆ PdfConformance() [6/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( IList< WellTaggedPdfConformance wtpdfConformance )
inline

Creates a new PdfConformance instance based on only Well Tagged PDF conformance.

Parameters
wtpdfConformance the Well Tagged PDF conformance

◆ PdfConformance() [7/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( WellTaggedPdfConformance  wtpdfConformance )
inline

Creates a new PdfConformance instance based on only Well Tagged PDF conformance.

Parameters
wtpdfConformance the Well Tagged PDF conformance

◆ PdfConformance() [8/8]

iText.Kernel.Pdf.PdfConformance.PdfConformance ( )
inline

Creates a new PdfConformance instance without any conformance.

Member Function Documentation

◆ ConformsTo() [1/4]

virtual bool iText.Kernel.Pdf.PdfConformance.ConformsTo ( params iText.Kernel.Pdf.PdfConformance[]  conformanceList )
inlinevirtual

Checks if any of specified conformance is present in this PdfConformance instance.

Parameters
conformanceList the conformances to check
Returns

true if any of specified conformances is present in this PdfConformance instance, otherwise false

◆ ConformsTo() [2/4]

virtual bool iText.Kernel.Pdf.PdfConformance.ConformsTo ( PdfAConformance  aConformance )
inlinevirtual

Checks if specified PDF/A conformance is present in this PdfConformance instance.

Parameters
aConformance the PDF/A conformance to check
Returns

true if specified PDF/A conformance is present in this PdfConformance instance, otherwise

◆ ConformsTo() [3/4]

virtual bool iText.Kernel.Pdf.PdfConformance.ConformsTo ( PdfUAConformance  uaConformance )
inlinevirtual

Checks if specified PDF/UA conformance is present in this PdfConformance instance.

Parameters
uaConformance the PDF/UA conformance to check
Returns

true if specified PDF/UA conformance is present in this PdfConformance instance, otherwise

◆ ConformsTo() [4/4]

virtual bool iText.Kernel.Pdf.PdfConformance.ConformsTo ( WellTaggedPdfConformance  wtPdfConformance )
inlinevirtual

Gets the WellTaggedPdfConformance instance if specified.

Parameters
wtPdfConformance the Well Tagged PDF conformance to check
Returns
the specified WellTaggedPdfConformance instance or null.

◆ ConformsToAny()

virtual bool iText.Kernel.Pdf.PdfConformance.ConformsToAny ( )
inlinevirtual

Checks if any of PDF/A, PDF/UA or Well Tagged PDF conformance is specified

Returns

true if PDF/A, PDF/UA or Well Tagged PDF conformance is specified, otherwise false

◆ GetAConformance() [1/2]

virtual PdfAConformance iText.Kernel.Pdf.PdfConformance.GetAConformance ( )
inlinevirtual

Gets the PdfAConformance instance if specified.

Returns
the specified PdfAConformance instance or null.

◆ GetAConformance() [2/2]

static PdfAConformance iText.Kernel.Pdf.PdfConformance.GetAConformance ( String  part,
String  level 
)
inlinestatic

Gets an instance of PdfAConformance based on passed part and level.

Parameters
part the part of PDF/A conformance
level the level of PDF/A conformance
Returns
the PdfAConformance instance or null if there is no PDF/A conformance for passed parameters

◆ GetConformance()

static iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.GetConformance ( XMPMeta  meta )
inlinestatic

Gets PdfConformance instance from iText.Kernel.XMP.XMPMeta.

Parameters
meta the meta data to parse
Returns
the PdfConformance instance

◆ GetUAConformance()

virtual PdfUAConformance iText.Kernel.Pdf.PdfConformance.GetUAConformance ( )
inlinevirtual

Gets the PdfUAConformance instance if specified.

Returns
the specified PdfUAConformance instance or null.

◆ GetWtpdfConformances()

virtual IList<WellTaggedPdfConformance> iText.Kernel.Pdf.PdfConformance.GetWtpdfConformances ( )
inlinevirtual

Gets the list of WellTaggedPdfConformance instances if specified.

Returns
the list of specified WellTaggedPdfConformance instances or empty list.

◆ Includes()

virtual bool iText.Kernel.Pdf.PdfConformance.Includes ( iText.Kernel.Pdf.PdfConformance  conformance )
inlinevirtual

Checks if passed conformance is fully included into this PdfConformance

Parameters
conformance the conformance to check
Returns

true if conformance is fully included into this conformance, otherwise false

◆ IsPdfA()

virtual bool iText.Kernel.Pdf.PdfConformance.IsPdfA ( )
inlinevirtual

Checks if any PDF/A conformance is specified.

Returns

true if PDF/A conformance is specified, otherwise false

◆ IsPdfAOrUa()

virtual bool iText.Kernel.Pdf.PdfConformance.IsPdfAOrUa ( )
inlinevirtual

Checks if any PDF/A or PDF/UA conformance is specified.

Returns

true if PDF/A or PDF/UA conformance is specified, otherwise false

◆ IsPdfUA()

virtual bool iText.Kernel.Pdf.PdfConformance.IsPdfUA ( )
inlinevirtual

Checks if any PDF/UA conformance is specified.

Returns

true if PDF/UA conformance is specified, otherwise false

◆ IsWellTaggedConformanceIncluded()

virtual bool iText.Kernel.Pdf.PdfConformance.IsWellTaggedConformanceIncluded ( iText.Kernel.Pdf.PdfConformance  conformance )
inlinevirtual

Checks if well tagged conformance part of passed conformance is included into this PdfConformance

Parameters
conformance the conformance to check
Returns

true if well tagged conformance of this conformance is included, otherwise false

◆ IsWtpdf()

virtual bool iText.Kernel.Pdf.PdfConformance.IsWtpdf ( )
inlinevirtual

Checks if any Well Tagged PDF conformance is specified.

Returns

true if Well Tagged PDF conformance is specified, otherwise false

◆ SetConformanceToXmp() [1/2]

virtual void iText.Kernel.Pdf.PdfConformance.SetConformanceToXmp ( XMPMeta  xmpMeta )
inlinevirtual

Sets required fields into XMP metadata according to passed PDF conformance.

Parameters
xmpMeta the xmp metadata to which required PDF conformance fields will be set

◆ SetConformanceToXmp() [2/2]

static void iText.Kernel.Pdf.PdfConformance.SetConformanceToXmp ( XMPMeta  xmpMeta,
iText.Kernel.Pdf.PdfConformance  conformance 
)
inlinestatic

Sets required fields into XMP metadata according to passed PDF conformance.

Parameters
xmpMeta the xmp metadata to which required PDF conformance fields will be set
conformance the PDF conformance which fields should be set into XMP metadata.

Member Data Documentation

◆ PDF_A_1A

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_1A
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_1A)

◆ PDF_A_1B

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_1B
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_1B)

◆ PDF_A_2A

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_2A
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_2A)

◆ PDF_A_2B

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_2B
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_2B)

◆ PDF_A_2U

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_2U
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_2U)

◆ PDF_A_3A

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_3A
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_3A)

◆ PDF_A_3B

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_3B
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_3B)

◆ PDF_A_3U

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_3U
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_3U)

◆ PDF_A_4

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_4
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_4)

◆ PDF_A_4E

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_4E
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_4E)

◆ PDF_A_4F

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_A_4F
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfAConformance
.PDF_A_4F)

◆ PDF_NONE_CONFORMANCE

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_NONE_CONFORMANCE
static
Initial value:

◆ PDF_UA_1

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_UA_1
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfUAConformance
.PDF_UA_1)

◆ PDF_UA_2

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.PDF_UA_2
static
Initial value:
= new iText.Kernel.Pdf.PdfConformance(PdfUAConformance
.PDF_UA_2)

◆ WELL_TAGGED_PDF_FOR_ACCESSIBILITY

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.WELL_TAGGED_PDF_FOR_ACCESSIBILITY
static
Initial value:
(JavaCollectionsUtil.SingletonList(WellTaggedPdfConformance.FOR_ACCESSIBILITY))

◆ WELL_TAGGED_PDF_FOR_REUSE

readonly iText.Kernel.Pdf.PdfConformance iText.Kernel.Pdf.PdfConformance.WELL_TAGGED_PDF_FOR_REUSE
static
Initial value:
(JavaCollectionsUtil.SingletonList(WellTaggedPdfConformance.FOR_REUSE))
iText.Kernel.Pdf.PdfConformance
The class represents possible PDF document conformance.
Definition: PdfConformance.cs:32
iText.Kernel.Pdf
Definition: PdfAction.cs:34
iText.Kernel
Definition: ITextCoreProductData.cs:27
iText.Kernel.Pdf.WellTaggedPdfConformance
WellTaggedPdfConformance
Well Tagged PDF is a conformance for PDF files that ensures the files are accessible to all users.
Definition: WellTaggedPdfConformance.cs:30
iText
Definition: Barcode128.cs:37