iText 8.0.2 API
iText.Kernel.Pdf.Tagging.StandardNamespaces Class Reference

This class encapsulates information about the standard structure namespaces and provides some utility methods connected to them. More...

Static Public Member Functions

static String  GetDefault ()
  Gets the name of the default standard structure namespace. More...
 
static bool  IsKnownDomainSpecificNamespace (PdfNamespace @namespace)
  Checks if the given namespace is identified as the one that is common within broad ranges of documents types and doesn't require a role mapping for it's roles. More...
 
static bool  RoleBelongsToStandardNamespace (String role, String standardNamespaceName)
  Checks if the given role is considered standard in the specified standard namespace. More...
 
static bool  IsHnRole (String role)
  Checks if the given role matches the Hn role pattern. More...
 

Static Public Attributes

const String  PDF_1_7 = "http://iso.org/pdf/ssn"
  Specifies the name of the standard structure namespace for PDF 1.7 More...
 
const String  PDF_2_0 = "http://iso.org/pdf2/ssn"
  Specifies the name of the standard structure namespace for PDF 2.0 More...
 

Detailed Description

This class encapsulates information about the standard structure namespaces and provides some utility methods connected to them.

This class encapsulates information about the standard structure namespaces and provides some utility methods connected to them. The main purpose of this class is to determine if the given role in the specified namespace belongs to the standard or known domain-specific namespace.

See ISO 32000-2 14.8.6, "Standard structure namespaces"

Member Function Documentation

◆ GetDefault()

static String iText.Kernel.Pdf.Tagging.StandardNamespaces.GetDefault ( )
inlinestatic

Gets the name of the default standard structure namespace.

Gets the name of the default standard structure namespace. When a namespace is not explicitly specified for a given structure element or attribute, it shall be assumed to be within this default standard structure namespace. According to ISO 32000-2 default namespace is PDF_1_7.

Returns
the name of the default standard structure namespace.

◆ IsHnRole()

static bool iText.Kernel.Pdf.Tagging.StandardNamespaces.IsHnRole ( String  role )
inlinestatic

Checks if the given role matches the Hn role pattern.

Checks if the given role matches the Hn role pattern. To match this pattern, the given role shall always consist of the uppercase letter "H" and one or more digits, representing an unsigned integer greater than or equal to 1, without leading zeroes or any other prefix or postfix.

Parameters
role a System.String that specifies a role to be checked against Hn role pattern.
Returns
true if the role matches, false otherwise.

◆ IsKnownDomainSpecificNamespace()

static bool iText.Kernel.Pdf.Tagging.StandardNamespaces.IsKnownDomainSpecificNamespace ( PdfNamespace namespace )
inlinestatic

Checks if the given namespace is identified as the one that is common within broad ranges of documents types and doesn't require a role mapping for it's roles.

Parameters
namespace a namespace to be checked, whether it defines a namespace of the known domain specific language.
Returns
true, if the given PdfNamespace belongs to the domain-specific namespace, false otherwise.

◆ RoleBelongsToStandardNamespace()

static bool iText.Kernel.Pdf.Tagging.StandardNamespaces.RoleBelongsToStandardNamespace ( String  role,
String  standardNamespaceName 
)
inlinestatic

Checks if the given role is considered standard in the specified standard namespace.

Parameters
role a role to be checked if it is standard in the given standard structure namespace.
standardNamespaceName a System.String identifying standard structure namespace against which given role will be checked.
Returns
false if the given role doesn't belong to the standard roles of the given standard structure namespace or if the given namespace name is not standard; true otherwise.

Member Data Documentation

◆ PDF_1_7

const String iText.Kernel.Pdf.Tagging.StandardNamespaces.PDF_1_7 = "http://iso.org/pdf/ssn"
static

Specifies the name of the standard structure namespace for PDF 1.7

◆ PDF_2_0

const String iText.Kernel.Pdf.Tagging.StandardNamespaces.PDF_2_0 = "http://iso.org/pdf2/ssn"
static

Specifies the name of the standard structure namespace for PDF 2.0