FOM Reference > Formatting > PDF > fPDFTagElement interface
  
fPDFTagElement interface
This object defines a PDF Tag Element. This object inherits from fPDFTagItem.
ListNumberingTypes enumeration
The type of list numbering system used.
The ListNumberingTypes enumeration has the following constants of type int.
LIST_NONE = 0
No auto numbering or arbitrary text without numbering.
LIST_DECIMAL = 1
Decimal arabic numerals.
LIST_LOWERALPHA = 2
Lowercase letters.
LIST_LOWERROMAN = 3
Lowercase roman numerals.
LIST_UPPERALPHA = 4
Uppercase letters.
LIST_UPPERROMAN = 5
Uppercase roman numerals.
LIST_CIRCLE = 6
Open circular bullet.
LIST_DISC = 7
Solid circular bullet.
LIST_SQUARE = 8
Solid square bullet.
TableScopes enumeration
The scope that this table header cell applies to.
The TableScopes enumeration has the following constants of type int.
LIST_NONE = 0
The table header cell doesn't apply to any of the other cells.
SCOPE_ROW = 1
The table header cell applies to the rest of the cells in the row that contains it.
SCOPE_COLUMN = 2
The table header cell applies to the rest of the cells in the column that contains it.
SCOPE_BOTH = 3
The table header cell applies to the rest of the cells in both the row and the column that contains it.
actualText attribute
Text that is an exact replacement for the structure element and its children.
actualText
Access
read-write
Returns
String
alternateText attribute
An alternate description of the structure element and its children in human-readable form.
alternateText
Access
read-write
Returns
String
colSpan attribute
The number of table columns spanned by a cell.
colSpan
Access
read-write
Returns
int
expandedText attribute
The expanded form of an abbreviation.
expandedText
Access
read-write
Returns
String
height attribute
The height of the element in userspace units. This property is only valid for Figure, Form, Formula, Table, TD and TH tags.
height
Access
read-write
Returns
float
id attribute
Assign an identifier to the element. The string must be unique among all structure elements.
id
Access
read-write
Returns
String
inline attribute
This determines if the element is written inline (when true) or as Structured Elements (when false, the default). This attribute is only used for roles: Span, Quote, Note, Reference, BibEntry & Code.
inline
Access
read-write
Returns
boolean
label attribute
Label for this pdf Tag.
label
Access
read-write
Returns
String
lang attribute
The language identifier specifying the natural language for all text in the structure element except where overridden by language specifications for nested structure elements. This must be a two-character ISO 639 language code (examples: DE, EN, FR, JA), optionally followed by a hyphen and a two-character ISO 3166 country code (examples: EN-US, EN-GB, ES-MX)
lang
Access
read-write
Returns
String
listNumbering attribute
Numbering system used for the contents of the Lbl elements in a numbered list or the symbol which precedes each item in an unnumbered list. Value is one of fPDFTagElement-ListNumberingTypes. This property is only valid for L tags.
listNumbering
Access
read-write
Returns
int
rowSpan attribute
The number of table rows spanned by a cell.
rowSpan
Access
read-write
Returns
int
tableHeaders attribute
The identifier of a table header cell (TH element) which is associated with the cell. The identifier must have been assigned to the target cell with the id option. This property is only valid for TH and TD tags.
tableHeaders
Access
read-write
Returns
String
tableScope attribute
This indicates whether the table header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it. Value is one of fPDFTagElement-TableScopes. This property is only valid for TH tags.
tableScope
Access
read-write
Returns
int
title attribute
The title of the structure element, a text string representing it in human-readable form. This attribute is note used for roles: Span, Quote, Note, Reference, BibEntry, Code, RB, RT, RP, WT & WP.
title
Access
read-write
Returns
String
width attribute
The width of the element in userspace units. This property is only valid for Figure, Form, Formula, Table, TD and TH tags.
width
Access
read-write
Returns
float
fPDFTagElement method
Creates a new PDF Tag Element.
fPDFTagElementname
Parameters
Stringname
The PDF Tag Name.
Returns
fPDFTagElement. A new instance of class fPDFTagElement.