The accessibility properties are used to define properties of structure elements in Tagged PDF documents via TagTreePointer API. More...

Inheritance diagram for iText.Kernel.Pdf.Tagutils.AccessibilityProperties:

Public Member Functions
virtual String	GetRole ()
	Gets the role of element. More...

virtual AccessibilityProperties	SetRole (String role)
	Sets the role of element. More...

virtual String	GetLanguage ()
	Gets the language identifier of element. More...

virtual AccessibilityProperties	SetLanguage (String language)
	Sets the language identifier of element. More...

virtual String	GetActualText ()
	Gets the actual text of element. More...

virtual AccessibilityProperties	SetActualText (String actualText)
	Sets the actual text of element. More...

virtual String	GetAlternateDescription ()
	Gets the alternate description of element. More...

virtual AccessibilityProperties	SetAlternateDescription (String alternateDescription)
	Sets the alternate description of element. More...

virtual String	GetExpansion ()
	Gets the expansion of element. More...

virtual AccessibilityProperties	SetExpansion (String expansion)
	Sets the expansion of element. More...

virtual String	GetPhoneme ()
	Gets the phoneme of element. More...

virtual AccessibilityProperties	SetPhoneme (String phoneme)
	Sets the phoneme of element. More...

virtual String	GetPhoneticAlphabet ()
	Gets the phonetic alphabet of element. More...

virtual AccessibilityProperties	SetPhoneticAlphabet (String phoneticAlphabet)
	Sets the phonetic alphabet of element. More...

virtual PdfNamespace	GetNamespace ()
	Gets the namespace of element. More...

virtual AccessibilityProperties	SetNamespace (PdfNamespace @namespace)
	Sets the namespace of element. More...

virtual AccessibilityProperties	AddRef (TagTreePointer treePointer)
	Adds the reference to other tagged element. More...

virtual IList< TagTreePointer >	GetRefsList ()
	Gets the list of references to other tagged elements. More...

virtual AccessibilityProperties	ClearRefs ()
	Clears the list of references to other tagged elements. More...

virtual AccessibilityProperties	AddAttributes (PdfStructureAttributes attributes)
	Adds the attributes to the element. More...

virtual AccessibilityProperties	AddAttributes (int index, PdfStructureAttributes attributes)
	Adds the attributes to the element with specified index. More...

virtual AccessibilityProperties	ClearAttributes ()
	Clears the list of attributes. More...

virtual IList< PdfStructureAttributes >	GetAttributesList ()
	Gets the attributes list. More...

virtual byte[]	GetStructureElementId ()
	Gets the associated structure element's ID string, if it has one. More...

virtual AccessibilityProperties	SetStructureElementId (byte[] id)
	Sets the associated structure element's ID. More...

virtual AccessibilityProperties	SetStructureElementIdString (String id)
	Sets the associated structure element's ID. More...

Detailed Description

The accessibility properties are used to define properties of structure elements in Tagged PDF documents via TagTreePointer API.

Member Function Documentation

◆ AddAttributes() [1/2]

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.AddAttributes	(	int	index,
		PdfStructureAttributes	attributes
	)

inlinevirtual

Adds the attributes to the element with specified index.

If an attribute with the same O and NS entries is specified more than once, the later (in array order) entry shall take precedence. For more information see PDF Specification ISO-32000 section 14.7.6.

Parameters

index	the attributes index
attributes	the attributes to be added

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ AddAttributes() [2/2]

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.AddAttributes ( PdfStructureAttributes attributes )

inlinevirtual

Adds the attributes to the element.

Parameters

attributes the attributes to be added

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ AddRef()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.AddRef ( TagTreePointer treePointer )

inlinevirtual

Adds the reference to other tagged element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Parameters

treePointer the reference to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ ClearAttributes()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.ClearAttributes ( )

inlinevirtual

Clears the list of attributes.

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ ClearRefs()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.ClearRefs ( )

inlinevirtual

Clears the list of references to other tagged elements.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetActualText()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetActualText ( )

inlinevirtual

Gets the actual text of element.

Returns: the actual text

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetAlternateDescription()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetAlternateDescription ( )

inlinevirtual

Gets the alternate description of element.

Returns: the alternate description

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetAttributesList()

virtual IList<PdfStructureAttributes> iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetAttributesList ( )

inlinevirtual

Gets the attributes list.

Returns: the attributes list

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetExpansion()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetExpansion ( )

inlinevirtual

Gets the expansion of element.

Expansion it is the expanded form of an abbreviation of structure element.

Returns: the expansion

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetLanguage()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetLanguage ( )

inlinevirtual

Gets the language identifier of element.

Gets the language identifier of element. Should be in format xy-ZK (for example en-US).

For more information see PDF Specification ISO 32000-1 section 14.9.2.

Returns: the language

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetNamespace()

virtual PdfNamespace iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetNamespace ( )

inlinevirtual

Gets the namespace of element.

Returns: the namespace

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetPhoneme()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetPhoneme ( )

inlinevirtual

Gets the phoneme of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneme(iText.Kernel.Pdf.PdfString).

Returns: the phoneme

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetPhoneticAlphabet()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetPhoneticAlphabet ( )

inlinevirtual

Gets the phonetic alphabet of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneticAlphabet(iText.Kernel.Pdf.PdfName).

Returns: the phonetic alphabet

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetRefsList()

virtual IList<TagTreePointer> iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetRefsList ( )

inlinevirtual

Gets the list of references to other tagged elements.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.AddRef(iText.Kernel.Pdf.Tagging.PdfStructElem).

Returns: the list of references

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetRole()

virtual String iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetRole ( )

inlinevirtual

Gets the role of element.

Returns: the role

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ GetStructureElementId()

virtual byte [] iText.Kernel.Pdf.Tagutils.AccessibilityProperties.GetStructureElementId ( )

inlinevirtual

Gets the associated structure element's ID string, if it has one.

Returns: the structure element's ID string, or null if there is none

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetActualText()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetActualText ( String actualText )

inlinevirtual

Sets the actual text of element.

Parameters

actualText the actual text to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetAlternateDescription()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetAlternateDescription ( String alternateDescription )

inlinevirtual

Sets the alternate description of element.

Parameters

alternateDescription the alternation description to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetExpansion()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetExpansion ( String expansion )

inlinevirtual

Sets the expansion of element.

Expansion it is the expanded form of an abbreviation of structure element.

Parameters

expansion the expansion to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetLanguage()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetLanguage ( String language )

inlinevirtual

Sets the language identifier of element.

Sets the language identifier of element. Should be in format xy-ZK (for example en-US).

For more information see PDF Specification ISO 32000-1 section 14.9.2.

Parameters

language the language to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetNamespace()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetNamespace ( PdfNamespace @ namespace )

inlinevirtual

Sets the namespace of element.

Parameters

namespace the namespace to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetPhoneme()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetPhoneme ( String phoneme )

inlinevirtual

Sets the phoneme of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneme(iText.Kernel.Pdf.PdfString).

Parameters

phoneme the phoneme to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetPhoneticAlphabet()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetPhoneticAlphabet ( String phoneticAlphabet )

inlinevirtual

Sets the phonetic alphabet of element.

For more information see iText.Kernel.Pdf.Tagging.PdfStructElem.SetPhoneticAlphabet(iText.Kernel.Pdf.PdfName).

Parameters

phoneticAlphabet the phonetic alphabet to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetRole()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetRole ( String role )

inlinevirtual

Sets the role of element.

Calling this method with a null argument will make the tagging on the associated layout element "neutral". The effect is that all children of the layout element will be tagged as if they were direct children of the parent element.

Parameters

role	the role to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetStructureElementId()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetStructureElementId ( byte[] id )

inlinevirtual

Sets the associated structure element's ID.

Sets the associated structure element's ID. Passing null removes the ID.

Parameters

id	the element's ID to be set

Returns: this AccessibilityProperties instance

Reimplemented in iText.Kernel.Pdf.Tagutils.DefaultAccessibilityProperties.

◆ SetStructureElementIdString()

virtual AccessibilityProperties iText.Kernel.Pdf.Tagutils.AccessibilityProperties.SetStructureElementIdString ( String id )

inlinevirtual

Sets the associated structure element's ID.

Sets the associated structure element's ID. Passing null removes the ID. If non-null, the argument will be encoded in UTF-8 (without BOM), since ID strings are considered binary data in PDF.

Parameters

id	the element's ID to be set

Returns: this AccessibilityProperties instance

Public Member Functions

Detailed Description

Member Function Documentation

◆ AddAttributes() [1/2]

◆ AddAttributes() [2/2]

◆ AddRef()

◆ ClearAttributes()

◆ ClearRefs()

◆ GetActualText()

◆ GetAlternateDescription()

◆ GetAttributesList()

◆ GetExpansion()

◆ GetLanguage()

◆ GetNamespace()

◆ GetPhoneme()

◆ GetPhoneticAlphabet()

◆ GetRefsList()

◆ GetRole()

◆ GetStructureElementId()

◆ SetActualText()

◆ SetAlternateDescription()

◆ SetExpansion()

◆ SetLanguage()

◆ SetNamespace()

◆ SetPhoneme()

◆ SetPhoneticAlphabet()

◆ SetRole()

◆ SetStructureElementId()

◆ SetStructureElementIdString()