FOM Reference > Formatting > PDF > fPDFRoleMap interface
  
fPDFRoleMap interface
This object defines a PDFRoleMap represents the PDFRoleMap stream in PTC ALD. This object inherits from fControl.
PDFTagRole enumeration
The role used for the named tag.
The PDFTagRole enumeration has the following constants of type int.
ROLE_ARTIFACT = 0
Objects that are typically not part of the desired content but content created in the course of producing the document, e.g, Headers & Footers. Content contained within an Artifact will not appear in the document’s logical structure.
ROLE_DOCUMENT = 1
A complete document. This is the root element of any structure tree containing multiple parts or multiple articles.
ROLE_PART = 2
A large-scale division of a document. This type of element is appropriate for grouping articles or sections.
ROLE_ART = 3
(Article) A relatively self-contained body of text constituting a single narrative or exposition. Articles should be disjoint; that is, they should not contain other articles as constituent elements.
ROLE_SECT = 4
(Section) A container for grouping related content elements. For example, a section might contain a heading, several introductory paragraphs, and two or more other sections nested within it as subsections.
ROLE_DIV = 5
(Division) A generic block-level element or group of elements.
ROLE_BLOCKQUOTE = 6
(Block quotation) A portion of text consisting of one or more paragraphs attributed to someone other than the author of the surrounding text.
ROLE_CAPTION = 7
A brief portion of text describing a table or figure.
ROLE_TOC = 8
(Table of contents) A list made up of table of contents item entries and/or other nested table of contents entries (TOC).
ROLE_TOCI = 9
(Table of contents item) An individual member of a table of contents.
ROLE_INDEX = 10
A sequence of entries containing identifying text accompanied by reference elements that point out occurrences of the specified text in the main body of a document.
ROLE_NONSTRUCT = 11
(Nonstructural element) A grouping element having no inherent structural significance; it serves solely for grouping purposes.
ROLE_PRIVATE = 12
A grouping element containing private content belonging to the application producing it.
ROLE_P = 13
(Paragraph) A low-level division of text.
ROLE_H = 14
(Heading) A label for a subdivision of a document’s content. It should be the first child of the division that it heads.
ROLE_H1 = 15
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_H2 = 16
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_H3 = 17
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_H4 = 18
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_H5 = 19
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_H6 = 20
Headings with specific level, for use in applications that cannot hierarchically nest their sections and thus cannot determine the level of a heading from its level of nesting.
ROLE_L = 21
(List) A sequence of items of like meaning and importance.
ROLE_LI = 22
(List item) An individual member of a list.
ROLE_LBL = 23
(Label) A name or number that distinguishes a given item from others in the same list or other group of like items. e.g. the number and punctuation in a numbered list.
ROLE_LBODY = 24
(List body) The descriptive content of a list item.
ROLE_TABLE = 25
A two-dimensional layout of rectangular data cells.
ROLE_THEAD = 26
(Table header row group; PDF 1.5) A group of rows that constitute the header of a table.
ROLE_TBODY = 27
(Table body row group; PDF 1.5) A group of rows that constitute the main body portion of a table.
ROLE_TFOOT = 28
(Table footer row group; PDF 1.5) A group of rows that constitute the footer of a table.
ROLE_TR = 29
(Table row) A row of headings or data in a table.
ROLE_TD = 30
(Table data cell) A table cell containing data that is part of the table’s content.
ROLE_TH = 31
(Table header cell) A table cell containing header text describing one or more rows of the table.
ROLE_SPAN = 32
A generic inline portion of text having no particular inherent characteristics.
ROLE_QUOTE = 33
(Quotation) An inline portion of text attributed to someone other than the author of the surrounding text.
ROLE_NOTE = 34
An item of explanatory text, such as a footnote or an endnote, that is referred to from within the body of the document.
ROLE_REFERENCE = 35
A citation to content elsewhere in the document.
ROLE_BIBENTRY = 36
(Bibliography entry) A reference identifying the external source of some cited content.
ROLE_CODE = 37
A fragment of computer program text.
ROLE_LINK = 38
An association between a portion of the ILSE’s content and a corresponding link annotation or annotations.
ROLE_ANNOT = 39
(Annotation; PDF 1.5) An association between a portion of the ILSE’s content and a corresponding PDF annotation.
ROLE_RUBY = 40
(PDF 1.5) A side-note (annotation) written in a smaller text size and placed adjacent to the base text to which it refers.
ROLE_RB = 41
(Ruby base text) The full-size text to which the ruby annotation is applied.
ROLE_RT = 42
(Ruby annotation text) The smaller-size text that is placed adjacent to the ruby base text.
ROLE_RP = 43
(Ruby punctuation) Punctuation surrounding the ruby annotation text.
ROLE_WARICHU = 44
(PDF 1.5) A comment or annotation in a smaller text size and formatted onto two smaller lines within the height of the containing text line and placed following (inline) the base text to which it refers.
ROLE_WT = 45
(Warichu text) The smaller-size text of a warichu comment that is formatted into two lines and placed between surrounding WP elements.
ROLE_WP = 46
(Warichu punctuation) The punctuation that surrounds the WT text.
ROLE_FIGURE = 47
An item of graphical content.
ROLE_FORMULA = 48
A mathematical formula.
ROLE_FORM = 49
A widget annotation representing an interactive form field.
roles attribute
The Array of name to role mappings. use the name as the array index, and assign it a fPDFRoleMap.PDFTagRole value.
roles
Access
read-only
Returns
fIntArray