Table of Contents

Class AccessibilityProperties

Namespace
iText.Kernel.Pdf.Tagutils
Assembly
itext.kernel.dll

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

public abstract class AccessibilityProperties
Inheritance
AccessibilityProperties
Derived
Inherited Members

Constructors

AccessibilityProperties() 

protected AccessibilityProperties()

Methods

AddAttributes(int, PdfStructureAttributes)

Adds the attributes to the element with specified index.

public virtual AccessibilityProperties AddAttributes(int index, PdfStructureAttributes attributes)

Parameters

index int

the attributes index

attributes PdfStructureAttributes

the attributes to be added

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

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.

AddAttributes(PdfStructureAttributes)

Adds the attributes to the element.

public virtual AccessibilityProperties AddAttributes(PdfStructureAttributes attributes)

Parameters

attributes PdfStructureAttributes

the attributes to be added

Returns

AccessibilityProperties

this AccessibilityProperties instance

AddRef(TagTreePointer)

Adds the reference to other tagged element.

public virtual AccessibilityProperties AddRef(TagTreePointer treePointer)

Parameters

treePointer TagTreePointer

the reference to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Adds the reference to other tagged element.

For more information see AddRef(PdfStructElem).

ClearAttributes()

Clears the list of attributes.

public virtual AccessibilityProperties ClearAttributes()

Returns

AccessibilityProperties

this AccessibilityProperties instance

ClearRefs()

Clears the list of references to other tagged elements.

public virtual AccessibilityProperties ClearRefs()

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Clears the list of references to other tagged elements.

For more information see AddRef(PdfStructElem).

GetActualText()

Gets the actual text of element.

public virtual string GetActualText()

Returns

string

the actual text

GetAlternateDescription()

Gets the alternate description of element.

public virtual string GetAlternateDescription()

Returns

string

the alternate description

GetAttributesList()

Gets the attributes list.

public virtual IList<PdfStructureAttributes> GetAttributesList()

Returns

IList<PdfStructureAttributes>

the attributes list

GetExpansion()

Gets the expansion of element.

public virtual string GetExpansion()

Returns

string

the expansion

Remarks

Gets the expansion of element.

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

GetLanguage()

Gets the language identifier of element.

public virtual string GetLanguage()

Returns

string

the language

Remarks

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.

GetNamespace()

Gets the namespace of element.

public virtual PdfNamespace GetNamespace()

Returns

PdfNamespace

the namespace

GetPhoneme()

Gets the phoneme of element.

public virtual string GetPhoneme()

Returns

string

the phoneme

Remarks

Gets the phoneme of element.

For more information see SetPhoneme(PdfString).

GetPhoneticAlphabet()

Gets the phonetic alphabet of element.

public virtual string GetPhoneticAlphabet()

Returns

string

the phonetic alphabet

Remarks

Gets the phonetic alphabet of element.

For more information see SetPhoneticAlphabet(PdfName).

GetRefsList()

Gets the list of references to other tagged elements.

public virtual IList<TagTreePointer> GetRefsList()

Returns

IList<TagTreePointer>

the list of references

Remarks

Gets the list of references to other tagged elements.

For more information see AddRef(PdfStructElem).

GetRole()

Gets the role of element.

public virtual string GetRole()

Returns

string

the role

Remarks

Gets the role of element.

See also StandardRoles.

GetStructureElementId()

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

public virtual byte[] GetStructureElementId()

Returns

byte[]

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

Remarks

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

See also GetStructureElementId().

SetActualText(string)

Sets the actual text of element.

public virtual AccessibilityProperties SetActualText(string actualText)

Parameters

actualText string

the actual text to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

SetAlternateDescription(string)

Sets the alternate description of element.

public virtual AccessibilityProperties SetAlternateDescription(string alternateDescription)

Parameters

alternateDescription string

the alternation description to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

SetExpansion(string)

Sets the expansion of element.

public virtual AccessibilityProperties SetExpansion(string expansion)

Parameters

expansion string

the expansion to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Sets the expansion of element.

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

SetLanguage(string)

Sets the language identifier of element.

public virtual AccessibilityProperties SetLanguage(string language)

Parameters

language string

the language to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

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.

SetNamespace(PdfNamespace)

Sets the namespace of element.

public virtual AccessibilityProperties SetNamespace(PdfNamespace @namespace)

Parameters

namespace PdfNamespace

the namespace to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

SetPhoneme(string)

Sets the phoneme of element.

public virtual AccessibilityProperties SetPhoneme(string phoneme)

Parameters

phoneme string

the phoneme to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Sets the phoneme of element.

For more information see SetPhoneme(PdfString).

SetPhoneticAlphabet(string)

Sets the phonetic alphabet of element.

public virtual AccessibilityProperties SetPhoneticAlphabet(string phoneticAlphabet)

Parameters

phoneticAlphabet string

the phonetic alphabet to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Sets the phonetic alphabet of element.

For more information see SetPhoneticAlphabet(PdfName).

SetRole(string)

Sets the role of element.

public virtual AccessibilityProperties SetRole(string role)

Parameters

role string

the role to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

Sets the role of element.

See also StandardRoles.

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.

SetStructureElementId(byte[])

Sets the associated structure element's ID.

public virtual AccessibilityProperties SetStructureElementId(byte[] id)

Parameters

id byte[]

the element's ID to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

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

See also SetStructureElementId(PdfString).

SetStructureElementIdString(string)

Sets the associated structure element's ID.

public virtual AccessibilityProperties SetStructureElementIdString(string id)

Parameters

id string

the element's ID to be set

Returns

AccessibilityProperties

this AccessibilityProperties instance

Remarks

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.

See also SetStructureElementId(PdfString).