Foxit PDF SDK

Public 类型 | Public 成员函数 | 静态 Public 成员函数 | 所有成员列表
foxit.addon.layoutrecognition.LRElement类 参考
类 foxit.addon.layoutrecognition.LRElement 继承关系图:

## Public 类型
enum | ElementType : uint { ElementType.e_ElementTypeDocument = 0x0000, ElementType.e_ElementTypeDocumentFragment = 0x0001, ElementType.e_ElementTypePart = 0x0002, ElementType.e_ElementTypeArt = 0x0101, ElementType.e_ElementTypeSect = 0x0102, ElementType.e_ElementTypeDiv = 0x0100, ElementType.e_ElementTypeBlockQuote = 0x0103, ElementType.e_ElementTypeCaption = 0x0104, ElementType.e_ElementTypeTOC = 0x0105, ElementType.e_ElementTypeTOCI = 0x0106, ElementType.e_ElementTypeIndex = 0x0107, ElementType.e_ElementTypeAside = 0x0108, ElementType.e_ElementTypeTitle = 0x0109, ElementType.e_ElementTypeFENote = 0x010A, ElementType.e_ElementTypeNonStruct = 0x010F, ElementType.e_ElementTypePrivate = 0x0110, ElementType.e_ElementTypeParagraph = 0x0200, ElementType.e_ElementTypeHeading = 0x0201, ElementType.e_ElementTypeHeading1 = 0x0202, ElementType.e_ElementTypeHeading2 = 0x0203, ElementType.e_ElementTypeHeading3 = 0x0204, ElementType.e_ElementTypeHeading4 = 0x0205, ElementType.e_ElementTypeHeading5 = 0x0206, ElementType.e_ElementTypeHeading6 = 0x0207, ElementType.e_ElementTypeHeadingN = 0x0208, ElementType.e_ElementTypeList = 0x0209, ElementType.e_ElementTypeListItem = 0x020A, ElementType.e_ElementTypeListLabel = 0x020B, ElementType.e_ElementTypeListBody = 0x020C, ElementType.e_ElementTypeTable = 0x020D, ElementType.e_ElementTypeTableRow = 0x020E, ElementType.e_ElementTypeTableHeaderCell = 0x020F, ElementType.e_ElementTypeTableDataCell = 0x0210, ElementType.e_ElementTypeTableHeaderGroup = 0x0211, ElementType.e_ElementTypeTableBodyGroup = 0x0212, ElementType.e_ElementTypeTableFootGroup = 0x0213, ElementType.e_ElementTypeSpan = 0x0300, ElementType.e_ElementTypeQuote = 0x0301, ElementType.e_ElementTypeNote = 0x0302, ElementType.e_ElementTypeReference = 0x0303, ElementType.e_ElementTypeBibEntry = 0x0304, ElementType.e_ElementTypeCode = 0x0305, ElementType.e_ElementTypeLink = 0x0306, ElementType.e_ElementTypeAnnot = 0x0307, ElementType.e_ElementTypeRuby = 0x0308, ElementType.e_ElementTypeRubyBase = 0x0309, ElementType.e_ElementTypeRubyAnnot = 0x030A, ElementType.e_ElementTypeRubyPunc = 0x030B, ElementType.e_ElementTypeWarichu = 0x030C, ElementType.e_ElementTypeWarichuText = 0x030D, ElementType.e_ElementTypeWarichuPunc = 0x030E, ElementType.e_ElementTypeEm = 0x030F, ElementType.e_ElementTypeStrong = 0x0310, ElementType.e_ElementTypeSub = 0x0311, ElementType.e_ElementTypeFigure = 0x0400, ElementType.e_ElementTypeFormula = 0x0401, ElementType.e_ElementTypeForm = 0x0402, ElementType.e_ElementTypeArtifact = 0x1000, ElementType.e_ElementTypeTextObject = 0x80000001, ElementType.e_ElementTypePathObject = 0x80000002, ElementType.e_ElementTypeImageObject = 0x80000003, ElementType.e_ElementTypeShadingObject = 0x80000004, ElementType.e_ElementTypeFormObject = 0x80000005, ElementType.e_ElementTypeContainerObject = 0x8000000C, ElementType.e_ElementTypeAnnotObject = 0x8000000E, ElementType.e_ElementTypePageObject = 0x8000000F, ElementType.e_ElementTypeTextContent = 0xC0000001, ElementType.e_ElementTypePathContent = 0xC0000002, ElementType.e_ElementTypeImageContent = 0xC0000003, ElementType.e_ElementTypeShadingContent = 0xC0000004, ElementType.e_ElementTypeComplexContent = 0xC000000D, ElementType.e_ElementTypeAnnotContent = 0xC000000E }
| 标准结构类型的枚举。 更多...

## Public 成员函数
| LRElement ()
| 构造函数。
| LRElement (LRElement other)
| 带参数的构造函数。 更多...
LRElement.ElementType | GetElementType ()
| 获取元素类型。 更多...
bool | IsContentElement ()
| 检查当前对象是否为内容元素。 更多...
bool | IsEmpty ()
| 检查当前对象是否为空。 更多...
bool | IsGraphicsObjectElement ()
| 检查当前对象是否为图形对象元素。 更多...
bool | IsStructureElement ()
| 检查当前对象是否为结构元素。 更多...
string | StringifyType ()
| 将当前元素的类型（枚举值）转换为简短且易记的字符串（文本）表示。 更多...

## 静态 Public 成员函数
static string | StringifyElementType (LRElement.ElementType type)
| 将指定元素类型的枚举值转换为简短且易记的字符串（文本）表示。 更多...

## 详细描述

此类表示基础布局识别元素。

## 成员枚举类型说明

## ◆ ElementType

enum foxit.addon.layoutrecognition.LRElement.ElementType : uint
| strong

标准结构类型的枚举。

此枚举的值应单独使用。 有关更多详细信息，请参阅<PDF Reference 1.7>第10.7.3节中"标准结构类型"的描述和<PDF Reference 2.0>第14.8.4节中"标准结构类型"的描述。

枚举值
e_ElementTypeDocument | 结构元素类型：Document，表示完整的文档。
e_ElementTypeDocumentFragment | 结构元素类型：DocumentFragment（PDF 2.0），表示原始完整文档的一部分。
e_ElementTypePart | 结构元素类型：Part，表示文档的大规模划分。
e_ElementTypeArt | 结构元素类型：Art，意为"Article"，表示构成单一叙述或阐述的 相对独立的文本主体。
e_ElementTypeSect | 结构元素类型：Sect，意为"Section"，表示用于 分组相关内容元素的容器。
e_ElementTypeDiv | 结构元素类型：Div，意为"Division"，表示通用的块级元素或 元素组。
e_ElementTypeBlockQuote | 结构元素类型：BlockQuote，意为"Block quotation"，表示 由一个或多个段落组成的文本部分，归属于 周围文本作者以外的人。
e_ElementTypeCaption | 结构元素类型：Caption，表示描述表格或图形的 简短文本部分。
e_ElementTypeTOC | 结构元素类型：TOC，意为"Table of contents"，表示 由目录项条目和/或其他嵌套目录条目组成的列表。
e_ElementTypeTOCI | 结构元素类型：TOCI，意为"Table of contents item"，表示 目录的单个成员。
e_ElementTypeIndex | 结构元素类型：Index，表示包含识别文本的条目序列， 伴随指向文档主体中指定文本出现位置的引用元素。
e_ElementTypeAside | 结构元素类型：Aside（PDF 2.0），表示与其父结构元素内 其他内容不同的内容。
e_ElementTypeTitle | 结构元素类型：Title（PDF 2.0），表示通常被称为文档或高级内容划分标题的内容。
e_ElementTypeFENote | 结构元素类型：FENote（PDF 2.0），用于标记脚注和尾注。
e_ElementTypeNonStruct | 结构元素类型：NonStruct，意为"Nonstructural element"，表示 没有固有结构意义的分组元素；它仅用于分组目的。
e_ElementTypePrivate | 结构元素类型：Private，意为"Private element"，表示 包含生成应用程序私有内容的分组元素。
e_ElementTypeParagraph | 结构元素类型：P，意为"Paragraph"，表示文本的低级划分。
e_ElementTypeHeading | 结构元素类型：H，意为"Heading"，表示文档内容细分的标签。 它应该是它所引导的划分的第一个子元素。
e_ElementTypeHeading1 | 结构元素类型：H1，表示1级标题。
e_ElementTypeHeading2 | 结构元素类型：H2，表示2级标题。
e_ElementTypeHeading3 | 结构元素类型：H3，表示3级标题。
e_ElementTypeHeading4 | 结构元素类型：H4，表示4级标题。
e_ElementTypeHeading5 | 结构元素类型：H5，表示5级标题。
e_ElementTypeHeading6 | 结构元素类型：H6，表示6级标题。
e_ElementTypeHeadingN | 结构元素类型：Hn（PDF 2.0），表示7级或更高级别的标题。
e_ElementTypeList | 结构元素类型：L，意为"List"，表示具有相似含义和重要性的项目序列。
e_ElementTypeListItem | 结构元素类型：LI，意为"List item"，表示列表的单个成员。
e_ElementTypeListLabel | 结构元素类型：Lbl，意为"Label"，表示用于区分给定项目与 同一列表或其他类似项目组中其他项目的名称或编号。
e_ElementTypeListBody | 结构元素类型：LBody，意为"List body"，表示 列表项的描述性内容。
e_ElementTypeTable | 结构元素类型：Table，表示矩形数据单元格的二维布局， 可能具有复杂的子结构。
e_ElementTypeTableRow | 结构元素类型：TR，意为"Table row"，表示 表格中的标题或数据行。
e_ElementTypeTableHeaderCell | 结构元素类型：TH，意为"Table header cell"，表示 包含描述表格一行或多行或列的标题文本的表格单元格。
e_ElementTypeTableDataCell | 结构元素类型：TD，意为"Table data cell"，表示 包含表格内容部分数据的表格单元格。
e_ElementTypeTableHeaderGroup | 结构元素类型：THead，意为"Table header row group"，表示 构成表格标题的行组。
e_ElementTypeTableBodyGroup | 结构元素类型：TBody，意为"Table body row group"，表示 构成表格主体部分的行组。
e_ElementTypeTableFootGroup | 结构元素类型：TFoot，意为"Table footer row group"，表示 构成表格页脚的行组。
e_ElementTypeSpan | 结构元素类型：Span，表示没有特定固有特征的 通用内联文本部分。
e_ElementTypeQuote | 结构元素类型：Quote，意为"Quotation"，表示 归属于周围文本作者以外的人的内联文本部分。
e_ElementTypeNote | 结构元素类型：Note，表示解释性文本项， 如脚注或尾注，在文档正文中被引用。
e_ElementTypeReference | 结构元素类型：Reference，表示对文档中 其他地方内容的引用。
e_ElementTypeBibEntry | 结构元素类型：BibEntry，意为"Bibliography entry"，表示 标识某些引用内容外部来源的参考文献。
e_ElementTypeCode | 结构元素类型：Code，表示计算机程序文本片段。
e_ElementTypeLink | 结构元素类型：Link，表示ILSE内容的一部分与 相应链接标注之间的关联。
e_ElementTypeAnnot | 结构元素类型：Annot，意为"Annotation"，表示 ILSE内容的一部分与相应PDF标注之间的关联。
e_ElementTypeRuby | 结构元素类型：Ruby，表示整个假名注音组合的包装器。
e_ElementTypeRubyBase | 结构元素类型：RB，意为"Ruby base text"，表示 应用假名注音的全尺寸文本。
e_ElementTypeRubyAnnot | 结构元素类型：RT，意为"Ruby annotation text"，表示 放置在假名基础文本旁边的较小尺寸文本。
e_ElementTypeRubyPunc | 结构元素类型：RP，意为"Ruby punctuation"，表示 围绕假名注音文本的标点符号。
e_ElementTypeWarichu | 结构元素类型：Warichu，表示整个割注组合的包装器。
e_ElementTypeWarichuText | 结构元素类型：WT，意为"Warichu text"，表示 割注注释的较小尺寸文本，格式化为两行并放置在周围WP元素之间。
e_ElementTypeWarichuPunc | 结构元素类型：WP，意为"Warichu punctuation"，表示 围绕WT文本的标点符号。
e_ElementTypeEm | 结构元素类型：Em（PDF 2.0），意为"Emphasis"，表示用于强调目的的内容。
e_ElementTypeStrong | 结构元素类型：Strong（PDF 2.0），表示用于 强烈重要性、严肃性或紧迫性的内容。
e_ElementTypeSub | 结构元素类型：Sub（PDF 2.0），意为"Sub-division of a block level element"，表示 通常被认为是块级结构元素内部细分的内容。
e_ElementTypeFigure | 结构元素类型：Figure，表示图形内容项。
e_ElementTypeFormula | 结构元素类型：Formula，表示数学公式。
e_ElementTypeForm | 结构元素类型：Form，表示代表交互式表单字段的 小部件标注。
e_ElementTypeArtifact | 结构元素类型：Artifact，包括其他分页、布局、 页面和背景人工制品。
e_ElementTypeTextObject | 结构元素类型：TextObject，表示文本图形对象元素。
e_ElementTypePathObject | 结构元素类型：PathObject，表示路径图形对象元素。
e_ElementTypeImageObject | 结构元素类型：ImageObject，表示图像图形对象元素。
e_ElementTypeShadingObject | 结构元素类型：ShadingObject，表示阴影图形对象元素。
e_ElementTypeFormObject | 结构元素类型：FormObject，表示表单XObject图形对象元素。
e_ElementTypeContainerObject | 结构元素类型：ContainerObject，表示容器对象元素。
e_ElementTypeAnnotObject | 结构元素类型：AnnotObject，表示标注对象元素。
e_ElementTypePageObject | 结构元素类型：PageObject，表示页面对象元素。
e_ElementTypeTextContent | 结构元素类型：TextContent，表示文本内容元素。
e_ElementTypePathContent | 结构元素类型：PathContent，表示路径内容元素。
e_ElementTypeImageContent | 结构元素类型：ImageContent，表示图像内容元素。
e_ElementTypeShadingContent | 结构元素类型：ShadingContent，表示阴影内容元素。
e_ElementTypeComplexContent | 结构元素类型：ComplexContent，表示复杂内容元素。
e_ElementTypeAnnotContent | 结构元素类型：AnnotContent，表示标注内容元素。

## 构造及析构函数说明

## ◆ LRElement()

foxit.addon.layoutrecognition.LRElement.LRElement | ( | LRElement | other | ) |
| inline

带参数的构造函数。

参数

  [in] | other | 另一个基础元素对象。

## 成员函数说明

## ◆ GetElementType()

LRElement.ElementType foxit.addon.layoutrecognition.LRElement.GetElementType | ( |  | ) |
| inline

获取元素类型。

返回
  元素类型。请参考从foxit.addon.layoutrecognition.LRElement.ElementType.e_ElementTypeDocument 开始的值， 这将是这些值中的一个。

## ◆ IsContentElement()

bool foxit.addon.layoutrecognition.LRElement.IsContentElement | ( |  | ) |
| inline

检查当前对象是否为内容元素。

返回
  true表示当前对象是内容元素， false表示当前对象不是内容元素。

## ◆ IsEmpty()

bool foxit.addon.layoutrecognition.LRElement.IsEmpty | ( |  | ) |
| inline

检查当前对象是否为空。

当当前对象为空时，意味着当前对象无用。

返回
  true表示当前对象为空，false表示非空。

## ◆ IsGraphicsObjectElement()

bool foxit.addon.layoutrecognition.LRElement.IsGraphicsObjectElement | ( |  | ) |
| inline

检查当前对象是否为图形对象元素。

返回
  true表示当前对象是图形对象元素， false表示当前对象不是图形对象元素。

## ◆ IsStructureElement()

bool foxit.addon.layoutrecognition.LRElement.IsStructureElement | ( |  | ) |
| inline

检查当前对象是否为结构元素。

返回
  true表示当前对象是结构元素， false表示当前对象不是结构元素。

## ◆ StringifyElementType()

static string foxit.addon.layoutrecognition.LRElement.StringifyElementType | ( | LRElement.ElementType | type | ) |
| inline static

将指定元素类型的枚举值转换为简短且易记的字符串（文本）表示。

参数

  [in] | type | 指定的元素类型。请参考从foxit.addon.layoutrecognition.LRElement.ElementType.e_ElementTypeDocument 开始的值， 这应该是这些值中的一个。

返回
  表示指定类型的简短且易记的字符串表示。 如果没有简短且易记的字符串表示或输入类型是无效的枚举值， 此函数将返回空字符串。

## ◆ StringifyType()

string foxit.addon.layoutrecognition.LRElement.StringifyType | ( |  | ) |
| inline

将当前元素的类型（枚举值）转换为简短且易记的字符串（文本）表示。

返回
  表示当前元素类型的简短且易记的字符串。 如果没有简短且易记的字符串，此函数将返回空字符串。