|
Foxit PDF SDK
|
静态 Public 成员函数 | |
| static bool | IsArrayAttributeValueType (AttributeValueType type) |
| 检查输入的属性值类型是否表示数组。 更多... | |
| static AttributeType | ParseAttributeType (String type_string) |
| 解析属性类型的字符串表示并获取此属性类型的枚举值。 更多... | |
| static String | StringifyAttributeType (AttributeType type) |
| 将指定属性类型的枚举值转换为简短且易记的字符串(文本)表示。 更多... | |
| static String | StringifyEnumVariant (AttributeValueEnum type) |
| 将指定属性值枚举的枚举值转换为简短且易记的字符串(文本)表示。 更多... | |
静态 Public 成员函数 继承自 foxit::addon::layoutrecognition::LRElement | |
| static String | StringifyElementType (ElementType type) |
| 将指定元素类型的枚举值转换为简短且易记的字符串(文本)表示。 更多... | |
此类表示结构元素。结构元素可用于构造树,如图形结构元素、段落 结构元素、跨度结构元素等。
元素通用布局属性类型的枚举。
此枚举的值应单独使用。 有关更多详细信息,请参阅<PDF reference 1.7> P916中的"布局属性"。
| 枚举值 | |
|---|---|
| e_AttributeTypeInvalid | 属性类型:无效。 |
| e_AttributeTypeRole | 属性类型:role,表示结构元素含义和它映射到的标准类型的字符串。
|
| e_AttributeTypePlacement | 属性类型:Placement,表示元素相对于封闭参考区域和其他内容的定位。 |
| e_AttributeTypeRotation | 属性类型:Rotation
|
| e_AttributeTypeWritingMode | 属性类型:WritingMode,表示ILSE打包(内联进程)和BLSE堆叠(块进程)的 布局进展方向。 |
| e_AttributeTypeDestination | 属性类型:Destination(PDF 2.0),提供访问内容的方法。
|
| e_AttributeTypeBBox | 属性类型:BBox,表示元素的边界框(完全包含其可见内容的矩形)。
|
| e_AttributeTypeWidth | 属性类型:Width,表示元素内容矩形的宽度。
|
| e_AttributeTypeHeight | 属性类型:Height,表示元素内容矩形的高度。
|
| e_AttributeTypeBackgroundColor | 属性类型:BackgroundColor,表示用于填充表格单元格或任何元素内容矩形背景的颜色。
|
| e_AttributeTypeBorderColor | 属性类型:BorderColor,表示在表格单元格或任何元素内容矩形边缘绘制的边框颜色。
|
| e_AttributeTypeBorderStyle | 属性类型:BorderStyle,表示元素边框的样式。
|
| e_AttributeTypeBorderThickness | 属性类型:BorderThickness,表示在表格单元格或任何元素内容矩形边缘绘制的边框厚度。
|
| e_AttributeTypeAttached | 属性类型:Attached,指定工件在逻辑上附加到页面的边缘(如果有的话)。 |
| e_AttributeTypeSubType | 属性类型:Subtype,表示注释或工件的子类型。
|
| e_AttributeTypePadding | 属性类型:Padding,指定用于元素内容矩形与周围边框之间分离的偏移。
|
| e_AttributeTypeColor | 属性类型:Color,表示用于绘制文本的颜色以及表格边框和文本装饰的默认颜色值。
|
| e_AttributeTypeSpaceBefore | 属性类型:SpaceBefore,表示BLSE前边缘之前的额外空间量。
|
| e_AttributeTypeSpaceAfter | 属性类型:SpaceAfter,表示BLSE后边缘之后的额外空间量。
|
| e_AttributeTypeStartIndent | 属性类型:StartIndent,表示从参考区域的开始边缘到BLSE开始边缘的距离。
|
| e_AttributeTypeEndIndent | 属性类型:EndIndent,表示从BLSE的结束边缘到参考区域结束边缘的距离。
|
| e_AttributeTypeTextIndent | 属性类型:TextIndent,表示从BLSE的开始边缘(由 LRStructureElement::e_AttributeTypeStartIndent指定) 到第一行文本的额外距离。
|
| e_AttributeTypeTextAlign | 属性类型:TextAlign,表示BLSE行内文本和其他内容的对齐方式。 |
| e_AttributeTypeBlockAlign | 属性类型:BlockAlign,表示表格单元格内容在块进展方向上的对齐方式。 |
| e_AttributeTypeInlineAlign | 属性类型:InlineAlign,表示表格单元格内容在内联进展方向上的对齐方式。 |
| e_AttributeTypeTBorderStyle | 属性类型:TBorderStyle,表示在表格单元格每个边缘绘制的边框样式。
|
| e_AttributeTypeTPadding | 属性类型:TPadding,指定用于表格单元格内容矩形与周围边框之间分离的偏移。
|
| e_AttributeTypeBaselineShift | 属性类型:BaselineShift,表示元素基线相对于其父元素基线的偏移距离。
|
| e_AttributeTypeLineHeight | 属性类型:LineHeight,表示元素在块进展方向上的首选高度。
|
| e_AttributeTypeTextDecorationColor | 属性类型:TextDecorationColor,表示用于绘制文本装饰的颜色。
|
| e_AttributeTypeTextDecorationThickness | 属性类型:TextDecorationThickness,表示作为文本装饰一部分绘制的每条线的厚度。
|
| e_AttributeTypeTextDecorationType | 属性类型:TextDecorationType,表示应用于元素文本的文本装饰(如果有的话)。 |
| e_AttributeTypeRubyAlign | 属性类型:RubyAlign,表示假名注音组合内行的对齐方式。 |
| e_AttributeTypeRubyPosition | 属性类型:RubyPosition,表示假名注音组合中RT结构元素相对于RB元素的位置。 |
| e_AttributeTypeGlyphOrientationVertical | 属性类型:GlyphOrientationVertical,指定当内联进展方向为从上到下或从下到上时字形的方向。
|
| e_AttributeTypeColumnCount | 属性类型:ColumnCount,表示分组元素内容中的列数。
|
| e_AttributeTypeColumnGap | 属性类型:ColumnGap,表示相邻列之间的期望空间,在内联进展方向上测量。
|
| e_AttributeTypeColumnWidths | 属性类型:ColumnWidths,表示列的期望宽度,在内联进展方向上测量。
|
| e_AttributeTypeListNumbering | 仅适用于List的属性类型:ListNumbering,表示用于生成自动编号列表中 Lbl(标签)元素内容的编号系统,或用于标识非编号列表中每个项目的符号。
|
| e_AttributeTypeFieldRole | 仅适用于PrintField的属性类型:Role,表示此图形所代表的表单字段类型。 |
| e_AttributeTypeFieldChecked | 仅适用于PrintField的属性类型:checked,表示单选按钮或复选框字段的状态。 |
| e_AttributeTypeFieldDesc | 仅适用于PrintField的属性类型:Desc,表示字段的备用名称, 类似于交互字段的字段字典中TU条目提供的值。
|
| e_AttributeTypeRowSpan | 仅适用于Table的属性类型:RowSpan,表示单元格跨越的封闭表格中的行数。
|
| e_AttributeTypeColSpan | 仅适用于Table的属性类型:ColSpan,表示单元格跨越的封闭表格中的列数。
|
| e_AttributeTypeTableHeaders | (当前不支持)仅适用于Table的属性类型:Headers,表示元素标识符数组。
|
| e_AttributeTypeTableHeaderScope | 仅适用于Table的属性类型:Scope,指示标题单元格是否适用于 包含它的行中的其余单元格、包含它的列或 包含它的行和列。 |
| e_AttributeTypeTableSummary | 仅适用于Table的属性类型:Summary,表示表格用途和结构的摘要, 用于非视觉渲染,如语音或盲文。
|
| e_AttributeTypeShort | 属性类型:Short(PDF 2.0),包含TH结构元素内容的简短形式。
|
| e_AttributeTypeDirection | (保留)属性类型:Direction。 |
| e_AttributeTypeABox | (保留)属性类型:ABox。
|
| e_AttributeTypeVersion | (保留)属性类型:Version,表示布局识别引擎的架构版本。
|
元素通用布局属性枚举值的枚举。
此枚举的值应单独使用。 这是所有值类型为枚举或枚举值数组的属性类型的枚举值集合。
| 枚举值 | |
|---|---|
| e_AttributeValueEnumInvalid | 无效的枚举值。 |
| e_AttributeValueEnumBlock | 枚举值:Block,表示在封闭的参考区域或父BLSE内按块进展方向堆叠。
|
| e_AttributeValueEnumInline | 枚举值:Inline,表示属性Placement/RubyPosition的位置。
|
| e_AttributeValueEnumWarichu | 枚举值:Warichu,表示RT和相关的RP元素应格式化为割注,跟随RB元素。 |
| e_AttributeValueEnumBefore | 枚举值:Before,表示属性Placement/RubyPosition的位置或属性BlockAlign的对齐。
|
| e_AttributeValueEnumAfter | 枚举值:After,表示属性BlockAlign的对齐或属性RubyPosition的位置。
|
| e_AttributeValueEnumStart | 枚举值:Start,表示属性Placement的位置,或属性TextAlign/InlineAlign/RubyAlign的对齐。
|
| e_AttributeValueEnumEnd | 枚举值:End,表示属性Placement的位置,或属性TextAlign/InlineAlign/RubyAlign的对齐。
|
| e_AttributeValueEnumLrTb | 枚举值:LrTb,表示从左到右的行进方向;从上到下的块进方向。 |
| e_AttributeValueEnumRlTb | 枚举值:RlTb,表示从右到左的行进方向; 从上到下的块进方向。 |
| e_AttributeValueEnumTbRl | 枚举值:TbRl,表示从上到下的行进方向;从右到左的块进方向。 |
| e_AttributeValueEnumTbLr | 枚举值:TbLr(PDF 2.0),表示从上到下的行进方向;从左到右的块进方向。 |
| e_AttributeValueEnumNone | 枚举值:None,表示没有此类属性。 |
| e_AttributeValueEnumHidden | 枚举值:Hidden,与None相同,除了在表格元素的边框冲突解决方面。 |
| e_AttributeValueEnumDotted | 枚举值:Dotted,表示边框是一系列点。 |
| e_AttributeValueEnumDashed | 枚举值:Dashed,表示边框是一系列短线段。 |
| e_AttributeValueEnumSolid | 枚举值:Solid,表示边框是单一线段。 |
| e_AttributeValueEnumDouble | 枚举值:Double,表示边框是两条实线。 |
| e_AttributeValueEnumGroove | 枚举值:Groove,表示边框看起来像刻在画布上的沟槽。 |
| e_AttributeValueEnumRidge | 枚举值:Ridge,表示边框看起来像从画布中凸出(与Groove相反)。 |
| e_AttributeValueEnumInset | 枚举值:Inset,表示边框使整个框看起来像嵌入画布中。 |
| e_AttributeValueEnumOutset | 枚举值:Outset,表示边框使整个框看起来像从画布中凸出(与Inset相反)。 |
| e_AttributeValueEnumNormal | @brief 枚举值:Normal,表示调整行高以包含任何非零值 BaselineShift属性指定的值。 @note 可用于属性类型 @link LRStructureElement::e_AttributeTypeLineHeight @endlink。 |
| e_AttributeValueEnumAuto | 枚举值:Auto。
|
| e_AttributeValueEnumCenter | 枚举值:Center,表示属性TextAlign/InlineAlign/RubyAlign的对齐。
|
| e_AttributeValueEnumJustify | 枚举值:Justify,表示属性TextAlign/BlockAlign/RubyAlign的对齐。
|
| e_AttributeValueEnumMiddle | 枚举值:Middle,表示子元素在表格单元格内居中。 |
| e_AttributeValueEnumUnderline | 枚举值:Underline,表示文本下方的线条。 |
| e_AttributeValueEnumOverline | 枚举值:Overline,表示文本上方的线条。 |
| e_AttributeValueEnumLineThrough | 枚举值:LineThrough,表示穿过文本中间的线条。 |
| e_AttributeValueEnumDistribute | 枚举值:Distribute,表示内容要在行进方向上扩展以填充可用宽度。
|
| e_AttributeValueEnumDisc | 枚举值:Disc,表示实心圆形项目符号。 |
| e_AttributeValueEnumCircle | 枚举值:Circle,表示空心圆形项目符号。 |
| e_AttributeValueEnumSquare | 枚举值:Square,表示实心方形项目符号。 |
| e_AttributeValueEnumDecimal | 枚举值:Decimal,表示十进制阿拉伯数字(1-9, 10-99, ...)。 |
| e_AttributeValueEnumUpperRoman | 枚举值:UpperRoman,表示大写罗马数字(I, II, III, IV, ...)。 |
| e_AttributeValueEnumLowerRoman | 枚举值:LowerRoman,表示小写罗马数字(i, ii, iii, iv, ...)。 |
| e_AttributeValueEnumUpperAlpha | 枚举值:UpperAlpha,表示大写字母(A, B, C, ...)。 |
| e_AttributeValueEnumLowerAlpha | 枚举值:LowerAlpha,表示小写字母(a, b, c, ...)。 |
| e_AttributeValueEnumUnordered | 枚举值:Unordered(PDF 2.0),表示具有未指定项目符号的无序列表。 |
| e_AttributeValueEnumOrdered | 枚举值:Ordered(PDF 2.0),表示具有未指定编号的有序列表。 |
| e_AttributeValueEnumFloat | 枚举值:float。 |
| e_AttributeValueEnumRB | 枚举值:rb,表示单选按钮。
|
| e_AttributeValueEnumCB | 枚举值:cb,表示复选框。
|
| e_AttributeValueEnumPB | 枚举值:pb,表示按钮。
|
| e_AttributeValueEnumTV | 枚举值:tv,表示文本值字段。
|
| e_AttributeValueEnumOn | 枚举值:on,表示状态为开启。 |
| e_AttributeValueEnumOff | 枚举值:off,表示状态为关闭。 |
| e_AttributeValueEnumNeutral | 枚举值:neutral,表示状态为中立。 |
| e_AttributeValueEnumRow | 枚举值:Row,表示表格的行。 |
| e_AttributeValueEnumColumn | 枚举值:Column,表示表格的列。 |
| e_AttributeValueEnumBoth | 枚举值:Both,表示表格的行和列。 |
| e_AttributeValueEnumLeft | 枚举值:Left,表示页面的左边缘。
|
| e_AttributeValueEnumTop | 枚举值:Top,表示页面的上边缘。
|
| e_AttributeValueEnumBottom | 枚举值:Bottom,表示页面的下边缘。
|
| e_AttributeValueEnumRight | 枚举值:Right,表示页面的右边缘。
|
| e_AttributeValueEnumPagination | 枚举值:Pagination,表示分页工件。辅助页面功能,如页眉页脚和页码。
|
| e_AttributeValueEnumLayout | 枚举值:Layout,表示布局工件。纯装饰性的排版或设计元素,如脚注规则或背景屏幕。
|
| e_AttributeValueEnumPage | 枚举值:Page,表示页面工件。与文档本身无关的生产辅助工具,如裁切标记和色彩条。
|
| e_AttributeValueEnumBackground | 枚举值:Background,表示背景工件。背景工件通常作为显示在其上方或放置在该背景旁边的内容的背景。
|
| e_AttributeValueEnumHeader | 枚举值:Header。 |
| e_AttributeValueEnumFooter | 枚举值:Footer。 |
| e_AttributeValueEnumWatermark | 枚举值:Watermark。 |
| e_AttributeValueEnumPageNum | 枚举值:PageNum(PDF2.0)。 |
| e_AttributeValueEnumBates | 枚举值:Bates(PDF2.0)。 |
| e_AttributeValueEnumOther | 枚举值:Other(PDF 2.0)。
|
元素通用布局属性值类型的枚举。
此枚举的值应单独使用。
| foxit::addon::layoutrecognition::LRStructureElement::LRStructureElement | ( | const LRStructureElement & | other | ) |
带参数的构造函数。
| [in] | other | 另一个结构元素对象。 |
| foxit::addon::layoutrecognition::LRStructureElement::LRStructureElement | ( | const LRElement & | element | ) |
构造函数,使用父类对象。
| [in] | element | 父类对象。 |
| ARGB foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueARGB | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的ARGB值(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeARGB 或 LRStructureElement::e_AttributeValueTypeARGBArray 的属性。对于其他值类型,此函数将返回 0。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| int foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueCount | ( | AttributeType | type | ) |
获取指定属性类型的值数量。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| LRStructureElement foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueElement | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的结构元素对象(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeElement 或 LRStructureElement::e_AttributeValueTypeElementArray 的属性。对于其他值类型,此函数将返回一个结构元素, 其函数 LRStructureElement::IsEmpty 返回 true。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| AttributeValueEnum foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueEnum | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的枚举值(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeEnum 或 LRStructureElement::e_AttributeValueTypeEnumArray 的属性。对于其他值类型,此函数将返回 LRStructureElement::e_AttributeValueEnumInvalid。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| float foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueFloat | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的浮点值(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeFloat 或 LRStructureElement::e_AttributeValueTypeFloatArray 的属性。对于其他值类型,此函数将返回 0.0。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| int32 foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueInt32 | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的整数值(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeInt32 或 LRStructureElement::e_AttributeValueTypeInt32Array 的属性。对于其他值类型,此函数将返回 0。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| WString foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueString | ( | AttributeType | type, |
| int | index | ||
| ) |
获取指定属性类型的字符串值(由索引指定)。
此函数适用于值类型为 LRStructureElement::e_AttributeValueTypeWStr 或 LRStructureElement::e_AttributeValueTypeWStrArray 的属性。对于其他值类型,此函数将返回空字符串。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| [in] | index | 指定要检索哪个值的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetAttributeValueCount 返回。 |
| AttributeValueType foxit::addon::layoutrecognition::LRStructureElement::GetAttributeValueType | ( | AttributeType | type | ) |
获取指定属性类型的属性值类型。
| [in] | type | 属性类型。请参考从 LRStructureElement::e_AttributeTypeRole 开始的值,应该是这些值中的一个。 |
| RectF foxit::addon::layoutrecognition::LRStructureElement::GetBBox | ( | ) | const |
获取边界框。
| LRElement foxit::addon::layoutrecognition::LRStructureElement::GetChild | ( | int | index | ) |
通过索引获取子元素。
| [in] | index | 要检索的子元素的索引。有效范围:从 0 到(count-1)。 count 由函数 LRStructureElement::GetChildCount 返回。 |
| int foxit::addon::layoutrecognition::LRStructureElement::GetChildCount | ( | ) |
获取子元素的数量。
| LRStructureElement foxit::addon::layoutrecognition::LRStructureElement::GetParentElement | ( | ) | const |
获取父元素。
| AttributeType foxit::addon::layoutrecognition::LRStructureElement::GetSupportedAttribute | ( | int | index | ) |
通过索引获取支持的属性类型。
| [in] | index | 要获取类型的支持属性的索引。有效范围:从0到(count-1)。 count由函数LRStructureElement::GetSupportedAttributeCount返回。 |
| int foxit::addon::layoutrecognition::LRStructureElement::GetSupportedAttributeCount | ( | ) |
获取支持的属性数量。
|
static |
检查输入的属性值类型是否表示数组。
| [in] | type | 属性值类型。请参考从LRStructureElement::e_AttributeValueTypeEmpty开始的值, 这应该是这些值中的一个。 |
|
static |
解析属性类型的字符串表示并获取此属性类型的枚举值。
| [in] | type_string | 结构元素属性类型的字符串表示。 |
|
static |
将指定属性类型的枚举值转换为简短且易记的字符串(文本)表示。
| [in] | type | 指定属性类型的枚举值。请参考从LRStructureElement::e_AttributeTypeInvalid开始的值, 这应该是这些值中的一个。 |
|
static |
将指定属性值枚举的枚举值转换为简短且易记的字符串(文本)表示。
| [in] | type | 指定属性值枚举的枚举值。请参考从 LRStructureElement::e_AttributeValueEnumInvalid开始的值,这应该是这些值中的一个。 |