TOCIElement
Overview
TOCIElement is a class in Aspose.Pdf FOSS for Java.
Inherits from: Element.
Represents a Table of Contents Item (TOCI) structure element in the logical structure tree (ISO 32000-1:2008, §14.8.4.2, Table 333).
Properties
| Name | Type | Access | Description |
|---|---|---|---|
text | String | Read | Returns the actual text (/ActualText) of this element. |
language | String | Read | Returns the language (/Lang) of this element. |
structureElement | StructureElement | Read | Returns the underlying structure element. |
title | String | Read | Returns the title (/T) of this element. |
alternateDescription | String | Read | Returns the alternate description (/Alt) of this element. |
structureTextState | StructureTextState | Read | Returns the structure text state for this element. |
alternativeText | String | Read | Returns the alternative text (/Alt) for this element. |
positionSettings | PositionSettings | Read | Returns the position settings for this element. |
Methods
| Signature | Description |
|---|---|
TOCIElement(se: StructureElement) | Creates a TOCI element wrapping the given structure element. |
appendChild(child: Element) | Appends a child element. |
addRef(header: HeaderElement) | Adds a reference to a header element. |
setText(text: String) | Sets the actual text (/ActualText) for this element. |
getText() → String | Returns the actual text (/ActualText) of this element. |
setLanguage(lang: String) | Sets the language (/Lang) for this element. |
getLanguage() → String | Returns the language (/Lang) of this element. |
getStructureElement() → StructureElement | Returns the underlying structure element. |
setTitle(title: String) | Sets the title (/T) for this element. |
getTitle() → String | Returns the title (/T) of this element. |
setAlternateDescription(alt: String) | Sets the alternate description (/Alt) for this element. |
getAlternateDescription() → String | Returns the alternate description (/Alt) of this element. |
getStructureTextState() → StructureTextState | Returns the structure text state for this element. |
setAlternativeText(text: String) | Sets the alternative text (/Alt) for this element. |
getAlternativeText() → String | Returns the alternative text (/Alt) for this element. |
adjustPosition(settings: PositionSettings) | Adjusts the position of this element using the given settings. |
getPositionSettings() → PositionSettings | Returns the position settings for this element. |