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

Public 类型

enum  AttributeType {
  AttributeType.e_AttributeTypeInvalid = 0x0, AttributeType.e_AttributeTypeRole = 0x524f4c45, AttributeType.e_AttributeTypePlacement = 0x504c4143, AttributeType.e_AttributeTypeRotation = 0x524f5441,
  AttributeType.e_AttributeTypeWritingMode = 0x574d4f44, AttributeType.e_AttributeTypeDestination = 0x44455354, AttributeType.e_AttributeTypeBBox = 0x42424f58, AttributeType.e_AttributeTypeWidth = 0x57445448,
  AttributeType.e_AttributeTypeHeight = 0x48474854, AttributeType.e_AttributeTypeBackgroundColor = 0x424b4743, AttributeType.e_AttributeTypeBorderColor = 0x42445243, AttributeType.e_AttributeTypeBorderStyle = 0x42445253,
  AttributeType.e_AttributeTypeBorderThickness = 0x42445254, AttributeType.e_AttributeTypeAttached = 0x41545448, AttributeType.e_AttributeTypeSubType = 0x53554254, AttributeType.e_AttributeTypePadding = 0x50414447,
  AttributeType.e_AttributeTypeColor = 0x434f4c52, AttributeType.e_AttributeTypeSpaceBefore = 0x53504246, AttributeType.e_AttributeTypeSpaceAfter = 0x53504146, AttributeType.e_AttributeTypeStartIndent = 0x53494e44,
  AttributeType.e_AttributeTypeEndIndent = 0x45494e44, AttributeType.e_AttributeTypeTextIndent = 0x54494e44, AttributeType.e_AttributeTypeTextAlign = 0x54414c4e, AttributeType.e_AttributeTypeBlockAlign = 0x42414c4e,
  AttributeType.e_AttributeTypeInlineAlign = 0x49414c4e, AttributeType.e_AttributeTypeTBorderStyle = 0x54424453, AttributeType.e_AttributeTypeTPadding = 0x54504144, AttributeType.e_AttributeTypeBaselineShift = 0x42534846,
  AttributeType.e_AttributeTypeLineHeight = 0x4c484754, AttributeType.e_AttributeTypeTextDecorationColor = 0x5444434c, AttributeType.e_AttributeTypeTextDecorationThickness = 0x54445448, AttributeType.e_AttributeTypeTextDecorationType = 0x54445459,
  AttributeType.e_AttributeTypeRubyAlign = 0x5242414c, AttributeType.e_AttributeTypeRubyPosition = 0x52425053, AttributeType.e_AttributeTypeGlyphOrientationVertical = 0x474f5654, AttributeType.e_AttributeTypeColumnCount = 0x434c434e,
  AttributeType.e_AttributeTypeColumnGap = 0x434c4750, AttributeType.e_AttributeTypeColumnWidths = 0x434c5744, AttributeType.e_AttributeTypeListNumbering = 0x4c4e554d, AttributeType.e_AttributeTypeFieldRole = 0x46524f4c,
  AttributeType.e_AttributeTypeFieldChecked = 0x43484b44, AttributeType.e_AttributeTypeFieldDesc = 0x46445343, AttributeType.e_AttributeTypeRowSpan = 0x5253504e, AttributeType.e_AttributeTypeColSpan = 0x4353504e,
  AttributeType.e_AttributeTypeTableHeaders = 0x54484453, AttributeType.e_AttributeTypeTableHeaderScope = 0x54485343, AttributeType.e_AttributeTypeTableSummary = 0x5442534d, AttributeType.e_AttributeTypeShort = 0x53484f52,
  AttributeType.e_AttributeTypeDirection = 0x44495245, AttributeType.e_AttributeTypeABox = 0x414c4258, AttributeType.e_AttributeTypeVersion = 0x5645534e
}
 元素通用布局属性类型的枚举。 更多...
 
enum  AttributeValueEnum {
  AttributeValueEnum.e_AttributeValueEnumInvalid = 0x0, AttributeValueEnum.e_AttributeValueEnumBlock = 0x424c434b, AttributeValueEnum.e_AttributeValueEnumInline = 0x494e4c4e, AttributeValueEnum.e_AttributeValueEnumWarichu = 0x57415249,
  AttributeValueEnum.e_AttributeValueEnumBefore = 0x42454652, AttributeValueEnum.e_AttributeValueEnumAfter = 0x41465445, AttributeValueEnum.e_AttributeValueEnumStart = 0x53545254, AttributeValueEnum.e_AttributeValueEnumEnd = 0x454e4400,
  AttributeValueEnum.e_AttributeValueEnumLrTb = 0x4c525442, AttributeValueEnum.e_AttributeValueEnumRlTb = 0x524c5442, AttributeValueEnum.e_AttributeValueEnumTbRl = 0x5442524c, AttributeValueEnum.e_AttributeValueEnumTbLr = 0x54424c52,
  AttributeValueEnum.e_AttributeValueEnumNone = 0x4e4f4e45, AttributeValueEnum.e_AttributeValueEnumHidden = 0x4849444e, AttributeValueEnum.e_AttributeValueEnumDotted = 0x444f5444, AttributeValueEnum.e_AttributeValueEnumDashed = 0x44534844,
  AttributeValueEnum.e_AttributeValueEnumSolid = 0x534f4c44, AttributeValueEnum.e_AttributeValueEnumDouble = 0x44424c45, AttributeValueEnum.e_AttributeValueEnumGroove = 0x41525459, AttributeValueEnum.e_AttributeValueEnumRidge = 0x52444745,
  AttributeValueEnum.e_AttributeValueEnumInset = 0x494e5354, AttributeValueEnum.e_AttributeValueEnumOutset = 0x4f545354 , AttributeValueEnum.e_AttributeValueEnumAuto = 0x4155544f, AttributeValueEnum.e_AttributeValueEnumCenter = 0x434e5452,
  AttributeValueEnum.e_AttributeValueEnumJustify = 0x4a535459, AttributeValueEnum.e_AttributeValueEnumMiddle = 0x4d49444c, AttributeValueEnum.e_AttributeValueEnumUnderline = 0x55444c4e, AttributeValueEnum.e_AttributeValueEnumOverline = 0x4f564c4e,
  AttributeValueEnum.e_AttributeValueEnumLineThrough = 0x4c4e5448, AttributeValueEnum.e_AttributeValueEnumDistribute = 0x44535442, AttributeValueEnum.e_AttributeValueEnumDisc = 0x44495343, AttributeValueEnum.e_AttributeValueEnumCircle = 0x4352434c,
  AttributeValueEnum.e_AttributeValueEnumSquare = 0x53515552, AttributeValueEnum.e_AttributeValueEnumDecimal = 0x44434d4c, AttributeValueEnum.e_AttributeValueEnumUpperRoman = 0x5550524d, AttributeValueEnum.e_AttributeValueEnumLowerRoman = 0x4c57524d,
  AttributeValueEnum.e_AttributeValueEnumUpperAlpha = 0x5550414c, AttributeValueEnum.e_AttributeValueEnumLowerAlpha = 0x4c57414c, AttributeValueEnum.e_AttributeValueEnumUnordered = 0x554e4f52, AttributeValueEnum.e_AttributeValueEnumOrdered = 0x4f524445,
  AttributeValueEnum.e_AttributeValueEnumFloat = 0x464c4f54, AttributeValueEnum.e_AttributeValueEnumRB = 0x52420000, AttributeValueEnum.e_AttributeValueEnumCB = 0x43420000, AttributeValueEnum.e_AttributeValueEnumPB = 0x50440000,
  AttributeValueEnum.e_AttributeValueEnumTV = 0x54560000, AttributeValueEnum.e_AttributeValueEnumOn = 0x4f4e0000, AttributeValueEnum.e_AttributeValueEnumOff = 0x4f464600, AttributeValueEnum.e_AttributeValueEnumNeutral = 0x4e555452,
  AttributeValueEnum.e_AttributeValueEnumRow = 0x524f5700, AttributeValueEnum.e_AttributeValueEnumColumn = 0x434c4d4e, AttributeValueEnum.e_AttributeValueEnumBoth = 0x424f5448, AttributeValueEnum.e_AttributeValueEnumLeft = 0x4c454654,
  AttributeValueEnum.e_AttributeValueEnumTop = 0x544f5000, AttributeValueEnum.e_AttributeValueEnumBottom = 0x42544f4d, AttributeValueEnum.e_AttributeValueEnumRight = 0x52474854, AttributeValueEnum.e_AttributeValueEnumPagination = 0x5041474e,
  AttributeValueEnum.e_AttributeValueEnumLayout = 0x4c41594f, AttributeValueEnum.e_AttributeValueEnumPage = 0x50414745, AttributeValueEnum.e_AttributeValueEnumBackground = 0x424b474e, AttributeValueEnum.e_AttributeValueEnumHeader = 0x48454144,
  AttributeValueEnum.e_AttributeValueEnumFooter = 0x464f4f54, AttributeValueEnum.e_AttributeValueEnumWatermark = 0x57544d4b, AttributeValueEnum.e_AttributeValueEnumPageNum = 0x504e554d, AttributeValueEnum.e_AttributeValueEnumBates = 0x42415445,
  AttributeValueEnum.e_AttributeValueEnumOther = 0x4f544845
}
 元素通用布局属性枚举值的枚举。 更多...
 
enum  AttributeValueType {
  AttributeValueType.e_AttributeValueTypeEmpty = 0x0, AttributeValueType.e_AttributeValueTypeEnum = 0x1, AttributeValueType.e_AttributeValueTypeInt32 = 0x2, AttributeValueType.e_AttributeValueTypeFloat = 0x3,
  AttributeValueType.e_AttributeValueTypeARGB = 0x4, AttributeValueType.e_AttributeValueTypeWStr = 0x5, AttributeValueType.e_AttributeValueTypeElement = 0x6, AttributeValueType.e_AttributeValueTypeEnumArray = 0x101,
  AttributeValueType.e_AttributeValueTypeInt32Array = 0x102, AttributeValueType.e_AttributeValueTypeFloatArray = 0x103, AttributeValueType.e_AttributeValueTypeARGBArray = 0x104, AttributeValueType.e_AttributeValueTypeWStrArray = 0x105,
  AttributeValueType.e_AttributeValueTypeElementArray = 0x106
}
 元素通用布局属性值类型的枚举。 更多...
 
- Public 类型 继承自 foxit.addon.layoutrecognition.LRElement
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 成员函数

 LRStructureElement ()
 构造函数。
 
 LRStructureElement (LRStructureElement other)
 带参数的构造函数。 更多...
 
 LRStructureElement (LRElement element)
 构造函数，使用父类对象。 更多...
 
uint GetAttributeValueARGB (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的ARGB值（由索引指定）。 更多...
 
int GetAttributeValueCount (LRStructureElement.AttributeType type)
 获取指定属性类型的值数量。 更多...
 
LRStructureElement GetAttributeValueElement (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的结构元素对象（由索引指定）。 更多...
 
LRStructureElement.AttributeValueEnum GetAttributeValueEnum (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的枚举值（由索引指定）。 更多...
 
float GetAttributeValueFloat (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的浮点值（由索引指定）。 更多...
 
int GetAttributeValueInt32 (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的整数值（由索引指定）。 更多...
 
string GetAttributeValueString (LRStructureElement.AttributeType type, int index)
 获取指定属性类型的字符串值（由索引指定）。 更多...
 
LRStructureElement.AttributeValueType GetAttributeValueType (LRStructureElement.AttributeType type)
 获取指定属性类型的属性值类型。 更多...
 
RectF GetBBox ()
 获取边界框。 更多...
 
LRElement GetChild (int index)
 通过索引获取子元素。 更多...
 
int GetChildCount ()
 获取子元素的数量。 更多...
 
LRStructureElement GetParentElement ()
 获取父元素。 更多...
 
LRStructureElement.AttributeType GetSupportedAttribute (int index)
 通过索引获取支持的属性类型。 更多...
 
int GetSupportedAttributeCount ()
 获取支持的属性数量。 更多...
 
- Public 成员函数 继承自 foxit.addon.layoutrecognition.LRElement
 LRElement ()
 构造函数。
 
 LRElement (LRElement other)
 带参数的构造函数。 更多...
 
LRElement.ElementType GetElementType ()
 获取元素类型。 更多...
 
bool IsContentElement ()
 检查当前对象是否为内容元素。 更多...
 
bool IsEmpty ()
 检查当前对象是否为空。 更多...
 
bool IsGraphicsObjectElement ()
 检查当前对象是否为图形对象元素。 更多...
 
bool IsStructureElement ()
 检查当前对象是否为结构元素。 更多...
 
string StringifyType ()
 将当前元素的类型（枚举值）转换为简短且易记的字符串（文本）表示。 更多...
 

静态 Public 成员函数

static bool IsArrayAttributeValueType (LRStructureElement.AttributeValueType type)
 检查输入的属性值类型是否表示数组。 更多...
 
static LRStructureElement.AttributeType ParseAttributeType (string type_string)
 解析属性类型的字符串表示并获取此属性类型的枚举值。 更多...
 
static string StringifyAttributeType (LRStructureElement.AttributeType type)
 将指定属性类型的枚举值转换为简短且易记的字符串（文本）表示。 更多...
 
static string StringifyEnumVariant (LRStructureElement.AttributeValueEnum type)
 将指定属性值枚举的枚举值转换为简短且易记的字符串（文本）表示。 更多...
 
- 静态 Public 成员函数 继承自 foxit.addon.layoutrecognition.LRElement
static string StringifyElementType (LRElement.ElementType type)
 将指定元素类型的枚举值转换为简短且易记的字符串（文本）表示。 更多...
 

详细描述

此类表示结构元素。结构元素可用于构造树，如图形结构元素、段落 结构元素、跨度结构元素等。

成员枚举类型说明

◆ AttributeType

enum foxit.addon.layoutrecognition.LRStructureElement.AttributeType
strong

元素通用布局属性类型的枚举。

此枚举的值应单独使用。 有关更多详细信息，请参阅<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），提供访问内容的方法。

注解
此属性类型的值类型是包含ID的零个或多个字符串数组。
e_AttributeTypeBBox 

属性类型：BBox，表示元素的边界框（完全包含其可见内容的矩形）。

注解
此属性类型的值类型是中的四个数字数组， 给出元素边界框的左、下、右和上边缘的坐标。
e_AttributeTypeWidth 

属性类型：Width，表示元素内容矩形的宽度。

注解
此属性类型的值类型是数字或枚举值foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumAuto 。
e_AttributeTypeHeight 

属性类型：Height，表示元素内容矩形的高度。

注解
此属性类型的值类型是数字或枚举值foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumAuto 。
e_AttributeTypeBackgroundColor 

属性类型：BackgroundColor，表示用于填充表格单元格或任何元素内容矩形背景的颜色。

注解
此属性类型的值类型是RGB颜色。
e_AttributeTypeBorderColor 

属性类型：BorderColor，表示在表格单元格或任何元素内容矩形边缘绘制的边框颜色。

注解
此属性类型的值类型是RGB颜色或RGB颜色值数组。
e_AttributeTypeBorderStyle 

属性类型：BorderStyle，表示元素边框的样式。

注解
此属性类型的值类型是枚举或枚举值数组。 有效的枚举值有：
e_AttributeTypeBorderThickness 

属性类型：BorderThickness，表示在表格单元格或任何元素内容矩形边缘绘制的边框厚度。

注解
此属性类型的值类型是数字（适用于所有四个边缘）或 四个数字的数组（适用于边框的一个边缘，按照 前、后、开始和结束边缘的顺序）。
e_AttributeTypeAttached 

属性类型：Attached，指定工件在逻辑上附加到页面的边缘（如果有的话）。

注解
此属性类型的值类型是指定枚举值的数组。 有效的枚举值有：
e_AttributeTypeSubType 

属性类型：Subtype，表示注释或工件的子类型。

注解
此属性类型的值类型：
e_AttributeTypePadding 

属性类型：Padding，指定用于元素内容矩形与周围边框之间分离的偏移。

注解
此属性类型的值类型是数字（适用于所有四边）或 四个数字的数组（适用于前、后、开始和结束边缘）。
e_AttributeTypeColor 

属性类型：Color，表示用于绘制文本的颜色以及表格边框和文本装饰的默认颜色值。

注解
此属性类型的值类型是RGB颜色。
e_AttributeTypeSpaceBefore 

属性类型：SpaceBefore，表示BLSE前边缘之前的额外空间量。

注解
此属性类型的值类型是数字。
e_AttributeTypeSpaceAfter 

属性类型：SpaceAfter，表示BLSE后边缘之后的额外空间量。

注解
此属性类型的值类型是数字。
e_AttributeTypeStartIndent 

属性类型：StartIndent，表示从参考区域的开始边缘到BLSE开始边缘的距离。

注解
此属性类型的值类型是数字。
e_AttributeTypeEndIndent 

属性类型：EndIndent，表示从BLSE的结束边缘到参考区域结束边缘的距离。

注解
此属性类型的值类型是数字。
e_AttributeTypeTextIndent 

属性类型：TextIndent，表示从BLSE的开始边缘（由 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.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，表示用于绘制文本装饰的颜色。

注解
此属性类型的值类型是RGB颜色。
e_AttributeTypeTextDecorationThickness 

属性类型：TextDecorationThickness，表示作为文本装饰一部分绘制的每条线的厚度。

注解
此属性类型的值类型是数字。
e_AttributeTypeTextDecorationType 

属性类型：TextDecorationType，表示应用于元素文本的文本装饰（如果有的话）。

注解
此属性类型的值类型是枚举或指定枚举值数组。 有效的枚举值有：
e_AttributeTypeRubyAlign 

属性类型：RubyAlign，表示假名注音组合内行的对齐方式。

注解
此属性类型的值类型是枚举或指定枚举值数组。 有效的枚举值有：
e_AttributeTypeRubyPosition 

属性类型：RubyPosition，表示假名注音组合中RT结构元素相对于RB元素的位置。

注解
此属性类型的值类型是枚举。有效的枚举值有：
e_AttributeTypeGlyphOrientationVertical 

属性类型：GlyphOrientationVertical，指定当内联进展方向为从上到下或从下到上时字形的方向。

注解
此属性类型的值类型是数字（应该是指定数字-90、0、90、180和270中的一个）或 枚举（应该是值foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumAuto ）。
e_AttributeTypeColumnCount 

属性类型：ColumnCount，表示分组元素内容中的列数。

注解
此属性类型的值类型是数字。
e_AttributeTypeColumnGap 

属性类型：ColumnGap，表示相邻列之间的期望空间，在内联进展方向上测量。

注解
此属性类型的值类型可以是数字（适用于所有列）或数字数组。 当值类型是数组时：

  • 如果数组包含(ColumnCount-1)个数字，这些数字表示 第一列和第二列之间、第二列和第三列之间的空间，以此类推。

  • 如果少于(ColumnCount-1)个数字，最后一个元素指定 所有剩余的空间；多余的数组元素将被忽略。

e_AttributeTypeColumnWidths 

属性类型：ColumnWidths，表示列的期望宽度，在内联进展方向上测量。

注解
此属性类型的值类型可以是数字（适用于所有列）或数字数组。 当值类型是数组时：

  • 如果数组包含ColumnCount个数字，这些数字按顺序表示每列的宽度。

  • 如果少于ColumnCount个数字，最后一个元素指定 所有剩余的宽度；多余的数组元素将被忽略。

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，表示布局识别引擎的架构版本。

注解
此属性类型的值类型是数字。

◆ AttributeValueEnum

enum foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum
strong

元素通用布局属性枚举值的枚举。

此枚举的值应单独使用。 这是所有值类型为枚举或枚举值数组的属性类型的枚举值集合。

枚举值
e_AttributeValueEnumInvalid 

无效的枚举值。

e_AttributeValueEnumBlock 

枚举值：Block，表示在封闭的参考区域或父BLSE内按块进展方向堆叠。

注解
此值可与属性类型foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypePlacement 一起使用。
e_AttributeValueEnumInline 

枚举值：Inline，表示属性Placement/RubyPosition的位置。

  • 对于Placement属性，这意味着在包围的BLSE内沿行进方向进行打包。

  • 对于RubyPosition属性，这意味着RT和相关的RP元素应格式化为括号注释，跟随RB元素。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypePlacement 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyPosition 。
e_AttributeValueEnumWarichu 

枚举值：Warichu，表示RT和相关的RP元素应格式化为割注，跟随RB元素。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyPosition 。
e_AttributeValueEnumBefore 

枚举值：Before，表示属性Placement/RubyPosition的位置或属性BlockAlign的对齐。

  • 对于Placement属性，这意味着元素分配矩形的前边缘与最近包围参考区域的前边缘重合。

  • 对于BlockAlign属性，这意味着第一个子元素分配矩形的前边缘 aligned with that of the table cell's content rectangle.

  • For attribute RubyPosition, this means the placement of the RT structure element relative to the RB element in a ruby assembly.

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypePlacement ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBlockAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyPosition 。
e_AttributeValueEnumAfter 

枚举值：After，表示属性BlockAlign的对齐或属性RubyPosition的位置。

  • 对于BlockAlign属性，这意味着最后一个子元素分配矩形的后边缘与表格单元格内容矩形的后边缘对齐。

  • 对于RubyPosition属性，这意味着RT内容要沿元素的后边缘对齐。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBlockAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyPosition 。
e_AttributeValueEnumStart 

枚举值：Start，表示属性Placement的位置，或属性TextAlign/InlineAlign/RubyAlign的对齐。

  • 对于Placement属性，这意味着元素分配矩形的起始边缘与最近包围参考区域的起始边缘重合。

  • 对于TextAlign属性，这意味着与起始边缘对齐。

  • 对于InlineAlign属性，这意味着每个子元素分配矩形的起始边缘与表格单元格内容矩形的起始边缘对齐。

  • 对于RubyAlign属性，这意味着内容要在行进方向上沿起始边缘对齐。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypePlacement ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextAlign ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInlineAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyAlign 。
e_AttributeValueEnumEnd 

枚举值：End，表示属性Placement的位置，或属性TextAlign/InlineAlign/RubyAlign的对齐。

  • 对于Placement属性，这意味着元素分配矩形的结束边缘与最近包围参考区域的结束边缘重合。

  • 对于TextAlign属性，这意味着与结束边缘对齐。

  • 对于InlineAlign属性，这意味着每个子元素分配矩形的结束边缘与表格单元格内容矩形的结束边缘对齐。

  • 对于RubyAlign属性，这意味着内容要在行进方向上沿结束边缘对齐。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypePlacement ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextAlign ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInlineAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyAlign 。
e_AttributeValueEnumLrTb 

枚举值：LrTb，表示从左到右的行进方向；从上到下的块进方向。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeWritingMode 。
e_AttributeValueEnumRlTb 

枚举值：RlTb，表示从右到左的行进方向； 从上到下的块进方向。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeWritingMode 。
e_AttributeValueEnumTbRl 

枚举值：TbRl，表示从上到下的行进方向；从右到左的块进方向。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeWritingMode 。
e_AttributeValueEnumTbLr 

枚举值：TbLr（PDF 2.0），表示从上到下的行进方向；从左到右的块进方向。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeWritingMode 。
e_AttributeValueEnumNone 

枚举值：None，表示没有此类属性。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextDecorationType ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumHidden 

枚举值：Hidden，与None相同，除了在表格元素的边框冲突解决方面。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumDotted 

枚举值：Dotted，表示边框是一系列点。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumDashed 

枚举值：Dashed，表示边框是一系列短线段。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumSolid 

枚举值：Solid，表示边框是单一线段。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumDouble 

枚举值：Double，表示边框是两条实线。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumGroove 

枚举值：Groove，表示边框看起来像刻在画布上的沟槽。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumRidge 

枚举值：Ridge，表示边框看起来像从画布中凸出（与Groove相反）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumInset 

枚举值：Inset，表示边框使整个框看起来像嵌入画布中。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumOutset 

枚举值：Outset，表示边框使整个框看起来像从画布中凸出（与Inset相反）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBorderStyle ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTBorderStyle 。
e_AttributeValueEnumAuto 

枚举值：Auto。

  • 对于Width和Height属性，这表示没有特定值，值将自动确定。

  • 对于LineHeight属性，这意味着不为BaselineShift的值进行调整。

  • 对于GlyphOrientationVertical属性，这为文本指定默认方向，取决于它是否为全宽（宽度与高度相等）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeWidth ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeHeight ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeLineHeight ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeGlyphOrientationVertical 。
e_AttributeValueEnumCenter 

枚举值：Center，表示属性TextAlign/InlineAlign/RubyAlign的对齐。

  • 对于TextAlign属性，这意味着在起始和结束边缘之间居中。

  • 对于InlineAlign属性，这意味着每个子元素在表格单元格内居中。

  • 对于RubyAlign属性，这意味着内容要在行进方向上居中。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextAlign ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInlineAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyAlign 。
e_AttributeValueEnumJustify 

枚举值：Justify，表示属性TextAlign/BlockAlign/RubyAlign的对齐。

  • 对于TextAlign属性，这意味着与起始和结束边缘都对齐，如果必要，扩展每行内的内部间距以实现这种对齐。

  • 对于BlockAlign属性，这意味着子元素与表格单元格内容矩形的前后边缘都对齐。

  • 对于RubyAlign属性，这意味着内容要在行进方向上居中。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextAlign ， foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBlockAlign ， 和 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyAlign 。
e_AttributeValueEnumMiddle 

枚举值：Middle，表示子元素在表格单元格内居中。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeBlockAlign 。
e_AttributeValueEnumUnderline 

枚举值：Underline，表示文本下方的线条。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextDecorationType 。
e_AttributeValueEnumOverline 

枚举值：Overline，表示文本上方的线条。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextDecorationType 。
e_AttributeValueEnumLineThrough 

枚举值：LineThrough，表示穿过文本中间的线条。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTextDecorationType 。
e_AttributeValueEnumDistribute 

枚举值：Distribute，表示内容要在行进方向上扩展以填充可用宽度。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRubyAlign 。
e_AttributeValueEnumDisc 

枚举值：Disc，表示实心圆形项目符号。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumCircle 

枚举值：Circle，表示空心圆形项目符号。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumSquare 

枚举值：Square，表示实心方形项目符号。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumDecimal 

枚举值：Decimal，表示十进制阿拉伯数字（1-9, 10-99, ...）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumUpperRoman 

枚举值：UpperRoman，表示大写罗马数字（I, II, III, IV, ...）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumLowerRoman 

枚举值：LowerRoman，表示小写罗马数字（i, ii, iii, iv, ...）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumUpperAlpha 

枚举值：UpperAlpha，表示大写字母（A, B, C, ...）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumLowerAlpha 

枚举值：LowerAlpha，表示小写字母（a, b, c, ...）。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumUnordered 

枚举值：Unordered（PDF 2.0），表示具有未指定项目符号的无序列表。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumOrdered 

枚举值：Ordered（PDF 2.0），表示具有未指定编号的有序列表。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeListNumbering 。
e_AttributeValueEnumFloat 

枚举值：float。

e_AttributeValueEnumRB 

枚举值：rb，表示单选按钮。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldRole 。
e_AttributeValueEnumCB 

枚举值：cb，表示复选框。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldRole 。
e_AttributeValueEnumPB 

枚举值：pb，表示按钮。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldRole 。
e_AttributeValueEnumTV 

枚举值：tv，表示文本值字段。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldRole 。
e_AttributeValueEnumOn 

枚举值：on，表示状态为开启。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldChecked 。
e_AttributeValueEnumOff 

枚举值：off，表示状态为关闭。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldChecked 。
e_AttributeValueEnumNeutral 

枚举值：neutral，表示状态为中立。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeFieldChecked 。
e_AttributeValueEnumRow 

枚举值：Row，表示表格的行。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTableHeaderScope 。
e_AttributeValueEnumColumn 

枚举值：Column，表示表格的列。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTableHeaderScope 。
e_AttributeValueEnumBoth 

枚举值：Both，表示表格的行和列。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeTableHeaderScope 。
e_AttributeValueEnumLeft 

枚举值：Left，表示页面的左边缘。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeAttached 。
e_AttributeValueEnumTop 

枚举值：Top，表示页面的上边缘。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeAttached 。
e_AttributeValueEnumBottom 

枚举值：Bottom，表示页面的下边缘。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeAttached 。
e_AttributeValueEnumRight 

枚举值：Right，表示页面的右边缘。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeAttached 。
e_AttributeValueEnumPagination 

枚举值：Pagination，表示分页工件。辅助页面功能，如页眉页脚和页码。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeSubType 。
e_AttributeValueEnumLayout 

枚举值：Layout，表示布局工件。纯装饰性的排版或设计元素，如脚注规则或背景屏幕。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeSubType 。
e_AttributeValueEnumPage 

枚举值：Page，表示页面工件。与文档本身无关的生产辅助工具，如裁切标记和色彩条。

注解
可用于属性类型 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeSubType 。
e_AttributeValueEnumBackground 

枚举值：Background，表示背景工件。背景工件通常作为显示在其上方或放置在该背景旁边的内容的背景。

注解
此值可与属性类型foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeSubType 一起使用。
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.AttributeType.e_AttributeTypeDirection 一起使用。

◆ AttributeValueType

enum foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType
strong

元素通用布局属性值类型的枚举。

此枚举的值应单独使用。

枚举值
e_AttributeValueTypeEmpty 

空值类型。

e_AttributeValueTypeEnum 

值类型：枚举。

e_AttributeValueTypeInt32 

值类型：32位有符号整数。

e_AttributeValueTypeFloat 

值类型：浮点数。

e_AttributeValueTypeARGB 

值类型：ARGB颜色类型，32位，((b) | ((g) << 8) | ((r) << 16)) | ((a) << 24)。

e_AttributeValueTypeWStr 

值类型：宽字符串。

e_AttributeValueTypeElement 

值类型：元素。

e_AttributeValueTypeEnumArray 

值类型：枚举值数组。

e_AttributeValueTypeInt32Array 

值类型：整数值数组。

e_AttributeValueTypeFloatArray 

值类型：浮点数值数组。

e_AttributeValueTypeARGBArray 

值类型：ARGB值数组。

e_AttributeValueTypeWStrArray 

值类型：宽字符串数组。

e_AttributeValueTypeElementArray 

值类型：元素数组。

构造及析构函数说明

◆ LRStructureElement() [1/2]

foxit.addon.layoutrecognition.LRStructureElement.LRStructureElement ( LRStructureElement  other)
inline

带参数的构造函数。

参数
[in]other另一个结构元素对象。

◆ LRStructureElement() [2/2]

foxit.addon.layoutrecognition.LRStructureElement.LRStructureElement ( LRElement  element)
inline

构造函数，使用父类对象。

参数
[in]element父类对象。

成员函数说明

◆ GetAttributeValueARGB()

uint foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueARGB ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的ARGB值（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeARGB 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeARGBArray 的属性。对于其他值类型，此函数将返回 0。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
ARGB值。

◆ GetAttributeValueCount()

int foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueCount ( LRStructureElement.AttributeType  type)
inline

获取指定属性类型的值数量。

  • 当属性类型的值类型表示数组时，此函数返回数组的大小。

  • 当属性类型的值类型不表示数组时，此函数将始终返回1。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
返回
指定属性类型的值数量。

◆ GetAttributeValueElement()

LRStructureElement foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueElement ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的结构元素对象（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeElement 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeElementArray 的属性。对于其他值类型，此函数将返回一个结构元素， 其函数 LRStructureElement::IsEmpty 返回 true。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
结构元素。

◆ GetAttributeValueEnum()

LRStructureElement.AttributeValueEnum foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueEnum ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的枚举值（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEnum 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEnumArray 的属性。对于其他值类型，此函数将返回 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid 。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
枚举值。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid 开始的值，这将是这些值中的一个。

◆ GetAttributeValueFloat()

float foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueFloat ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的浮点值（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeFloat 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeFloatArray 的属性。对于其他值类型，此函数将返回 0.0。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
浮点值。

◆ GetAttributeValueInt32()

int foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueInt32 ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的整数值（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeInt32 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeInt32Array 的属性。对于其他值类型，此函数将返回 0。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
整数值。

◆ GetAttributeValueString()

string foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueString ( LRStructureElement.AttributeType  type,
int  index 
)
inline

获取指定属性类型的字符串值（由索引指定）。

此函数适用于值类型为 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeWStr 或 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeWStrArray 的属性。对于其他值类型，此函数将返回空字符串。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
[in]index指定要检索哪个值的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetAttributeValueCount 返回。
返回
宽字符串值。

◆ GetAttributeValueType()

LRStructureElement.AttributeValueType foxit.addon.layoutrecognition.LRStructureElement.GetAttributeValueType ( LRStructureElement.AttributeType  type)
inline

获取指定属性类型的属性值类型。

参数
[in]type属性类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole 开始的值，应该是这些值中的一个。
返回
指定属性类型的值类型。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEmpty 开始的值，这将是这些值中的一个。

◆ GetBBox()

RectF foxit.addon.layoutrecognition.LRStructureElement.GetBBox ( )
inline

获取边界框。

返回
边界框。

◆ GetChild()

LRElement foxit.addon.layoutrecognition.LRStructureElement.GetChild ( int  index)
inline

通过索引获取子元素。

参数
[in]index要检索的子元素的索引。有效范围：从 0 到（count-1）。 count 由函数 LRStructureElement.GetChildCount 返回。
返回
子元素。

◆ GetChildCount()

int foxit.addon.layoutrecognition.LRStructureElement.GetChildCount ( )
inline

获取子元素的数量。

返回
子元素数量。

◆ GetParentElement()

LRStructureElement foxit.addon.layoutrecognition.LRStructureElement.GetParentElement ( )
inline

获取父元素。

返回
父元素。如果返回对象的函数 LRStructureElement::IsEmpty 返回 true， 表示当前元素没有父元素。

◆ GetSupportedAttribute()

LRStructureElement.AttributeType foxit.addon.layoutrecognition.LRStructureElement.GetSupportedAttribute ( int  index)
inline

通过索引获取支持的属性类型。

参数
[in]index要获取类型的支持属性的索引。有效范围：从0到(count-1)。 count由函数LRStructureElement.GetSupportedAttributeCount 返回。
返回
由索引指定的属性的属性类型。

◆ GetSupportedAttributeCount()

int foxit.addon.layoutrecognition.LRStructureElement.GetSupportedAttributeCount ( )
inline

获取支持的属性数量。

返回
支持的属性数量。

◆ IsArrayAttributeValueType()

static bool foxit.addon.layoutrecognition.LRStructureElement.IsArrayAttributeValueType ( LRStructureElement.AttributeValueType  type)
inlinestatic

检查输入的属性值类型是否表示数组。

参数
[in]type属性值类型。请参考从foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEmpty 开始的值， 这应该是这些值中的一个。
返回
true表示输入类型表示数组，false表示输入类型不表示数组。

◆ ParseAttributeType()

static LRStructureElement.AttributeType foxit.addon.layoutrecognition.LRStructureElement.ParseAttributeType ( string  type_string)
inlinestatic

解析属性类型的字符串表示并获取此属性类型的枚举值。

参数
[in]type_string结构元素属性类型的字符串表示。
返回
属性类型的枚举值。请参考从foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInvalid 开始的值， 这将是这些值中的一个。

◆ StringifyAttributeType()

static string foxit.addon.layoutrecognition.LRStructureElement.StringifyAttributeType ( LRStructureElement.AttributeType  type)
inlinestatic

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

参数
[in]type指定属性类型的枚举值。请参考从foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInvalid 开始的值， 这应该是这些值中的一个。
返回
表示指定类型的简短且易记的字符串表示。 如果没有简短且易记的字符串表示，或输入类型是foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInvalid 或无效的枚举值，此函数将返回空字符串。

◆ StringifyEnumVariant()

static string foxit.addon.layoutrecognition.LRStructureElement.StringifyEnumVariant ( LRStructureElement.AttributeValueEnum  type)
inlinestatic

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

参数
[in]type指定属性值枚举的枚举值。请参考从 foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid 开始的值，这应该是这些值中的一个。
返回
表示指定枚举的简短且易记的字符串表示。 如果没有简短且易记的字符串表示，或输入枚举值是foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid 或无效的枚举值，此函数将返回空字符串。