Foxit PDF SDK

Public 成员函数 | 静态 Public 属性 | 所有成员列表
FSDK::LRElement类 参考
类 FSDK::LRElement 继承关系图:

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

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

## 详细描述

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

## 成员函数说明

## ◆ GetElementType()

FSDK::LRElement::GetElementType | ( |  | ) |

获取元素类型。

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

## ◆ IsContentElement()

FSDK::LRElement::IsContentElement | ( |  | ) |

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

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

## ◆ IsEmpty()

FSDK::LRElement::IsEmpty | ( |  | ) |

检查当前对象是否为空。

当当前对象为空时,表示当前对象无用。

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

## ◆ IsGraphicsObjectElement()

FSDK::LRElement::IsGraphicsObjectElement | ( |  | ) |

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

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

## ◆ IsStructureElement()

FSDK::LRElement::IsStructureElement | ( |  | ) |

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

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

## ◆ StringifyElementType()

FSDK::LRElement::StringifyElementType | ( | type |  | ) |

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

参数

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

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

## ◆ StringifyType()

FSDK::LRElement::StringifyType | ( |  | ) |

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

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

## 类成员变量说明

## ◆ e_ElementTypeDocument

FSDK::LRElement::e_ElementTypeDocument
| static

标准结构类型的枚举。

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

结构元素类型：Document；表示完整文档。