Foxit PDF SDK
|
Public Member Functions | |
LRStructureElement () | |
Constructor. | |
LRStructureElement (LRStructureElement other) | |
Constructor, with another structure element object. More... | |
LRStructureElement (LRElement element) | |
Constructor, with parent class object. More... | |
uint | GetAttributeValueARGB (LRStructureElement.AttributeType type, int index) |
Get an ARGB value (specified by index) for specified attribute type. More... | |
int | GetAttributeValueCount (LRStructureElement.AttributeType type) |
Get value count of a specified attribute type. More... | |
LRStructureElement | GetAttributeValueElement (LRStructureElement.AttributeType type, int index) |
Get an structure element object (specified by index) for specified attribute type. More... | |
LRStructureElement.AttributeValueEnum | GetAttributeValueEnum (LRStructureElement.AttributeType type, int index) |
Get an enum value (specified by index) for specified attribute type. More... | |
float | GetAttributeValueFloat (LRStructureElement.AttributeType type, int index) |
Get a float value (specified by index) for specified attribute type. More... | |
int | GetAttributeValueInt32 (LRStructureElement.AttributeType type, int index) |
Get an integer value (specified by index) for specified attribute type. More... | |
string | GetAttributeValueString (LRStructureElement.AttributeType type, int index) |
Get a string value (specified by index) for specified attribute type. More... | |
LRStructureElement.AttributeValueType | GetAttributeValueType (LRStructureElement.AttributeType type) |
Get attribute value type for a specified attribute type. More... | |
RectF | GetBBox () |
Get bounding box. More... | |
LRElement | GetChild (int index) |
Get a child element by index. More... | |
int | GetChildCount () |
Get the count of children elements. More... | |
LRStructureElement | GetParentElement () |
Get the parent element. More... | |
LRStructureElement.AttributeType | GetSupportedAttribute (int index) |
Get a supported attribute type by index. More... | |
int | GetSupportedAttributeCount () |
Get supported attribute count. More... | |
![]() | |
LRElement () | |
Constructor. | |
LRElement (LRElement other) | |
Constructor, with another base element object. More... | |
LRElement.ElementType | GetElementType () |
Get element type. More... | |
bool | IsContentElement () |
Check whether current object is content element or not. More... | |
bool | IsEmpty () |
Check whether current object is empty or not. More... | |
bool | IsGraphicsObjectElement () |
Check whether current object is graphics object element or not. More... | |
bool | IsStructureElement () |
Check whether current object is structure element or not. More... | |
string | StringifyType () |
Convert type (enum value) of current element to a short and memorable string (text) representation. More... | |
Static Public Member Functions | |
static bool | IsArrayAttributeValueType (LRStructureElement.AttributeValueType type) |
Check whether input attribute value type represents an array. More... | |
static LRStructureElement.AttributeType | ParseAttributeType (string type_string) |
Parse a string representation for attribute type and retrieve the enum value for this attribute type. More... | |
static string | StringifyAttributeType (LRStructureElement.AttributeType type) |
Convert the enum value of a specified attribute type to a short and memorable string (text) representation. More... | |
static string | StringifyEnumVariant (LRStructureElement.AttributeValueEnum type) |
Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation. More... | |
![]() | |
static string | StringifyElementType (LRElement.ElementType type) |
Convert enum value of a specified element type to a short and memorable string (text) representation. More... | |
This class represents a structure element. A structure element can be used to construct a tree, like graphics structure element, paragraph structure element, span structure element and so on.
Enumeration for element general layout attribute types.
Values of this enumeration should be used alone. For more details, please refer to "Layout Attributes" in <PDF reference 1.7> P916.
Enumerator | |
---|---|
e_AttributeTypeInvalid |
Attribute type: invalid. |
e_AttributeTypeRole |
Attribute type: role, which means strings of structure element meaning and standard type it maps to.
|
e_AttributeTypePlacement |
Attribute type: Placement, which means the positioning of the element with respect to the enclosing reference area and other content.
|
e_AttributeTypeRotation |
Attribute type: Rotation.
|
e_AttributeTypeWritingMode |
Attribute type: WritingMode, which means the directions of layout progression for packing of ILSEs (inline progression) and stacking of BLSEs (block progression).
|
e_AttributeTypeDestination |
Attribute type: Destination (PDF 2.0), which provides a means to access content.
|
e_AttributeTypeBBox |
Attribute type: BBox, which represents the element's bounding box (the rectangle that completely encloses its visible content).
|
e_AttributeTypeWidth |
Attribute type: Width, which represents the width of the element's content rectangle.
|
e_AttributeTypeHeight |
Attribute type: Height, which represents the height of the element's content rectangle.
|
e_AttributeTypeBackgroundColor |
Attribute type: BackgroundColor, which represents the color to be used to fill the background of a table cell or any element's content rectangle.
|
e_AttributeTypeBorderColor |
Attribute type: BorderColor, which represents the color of the border drawn on the edges of a table cell or any element's content rectangle.
|
e_AttributeTypeBorderStyle |
Attribute type: BorderStyle, which represents the style of an element's border.
|
e_AttributeTypeBorderThickness |
Attribute type: BorderThickness, which represents the thickness of the border drawn on the edges of a table cell or any element's content rectangle.
|
e_AttributeTypeAttached |
Attribute type: Attached, which specifies the edges of the page, if any, to which the artifact is logically attached.
|
e_AttributeTypeSubType |
Attribute type: Subtype, which means the subtype of annotation or artifact.
|
e_AttributeTypePadding |
Attribute type: Padding, which specifies an offset to account for the separation between the element's content rectangle and the surrounding border.
|
e_AttributeTypeColor |
Attribute type: Color, which represents the color to be used for drawing text and the default value for the color of table borders and text decorations.
|
e_AttributeTypeSpaceBefore |
Attribute type: SpaceBefore, which represents the amount of extra space preceding the before edge of the BLSE.
|
e_AttributeTypeSpaceAfter |
Attribute type: SpaceAfter, which represents the amount of extra space following the after edge of the BLSE.
|
e_AttributeTypeStartIndent |
Attribute type: StartIndent, which represents the distance from the start edge of the reference area to that of the BLSE.
|
e_AttributeTypeEndIndent |
Attribute type: EndIndent, which represents the distance from the end edge of the BLSE to that of the reference area.
|
e_AttributeTypeTextIndent |
Attribute type: TextIndent, which represents the additional distance from the start edge of the BLSE, as specified by foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeStartIndent , to that of the first line of text.
|
e_AttributeTypeTextAlign |
Attribute type: TextAlign, which represents the alignment of text and other content within lines of the BLSE.
|
e_AttributeTypeBlockAlign |
Attribute type: BlockAlign, which represents the alignment, in the block-progression direction, of content within the table cell.
|
e_AttributeTypeInlineAlign |
Attribute type: InlineAlign, which represents the alignment, in the inline-progression direction, of content within the table cell.
|
e_AttributeTypeTBorderStyle |
Attribute type: TBorderStyle, which represents the style of the border drawn on each edge of a table cell.
|
e_AttributeTypeTPadding |
Attribute type: TPadding, which specifies an offset to account for the separation between the table cell's content rectangle and the surrounding border.
|
e_AttributeTypeBaselineShift |
Attribute type: BaselineShift, which means the distance by which the element's baseline is shifted relative to that of its parent element.
|
e_AttributeTypeLineHeight |
Attribute type: LineHeight, which means the element's preferred height, in the block-progression direction.
|
e_AttributeTypeTextDecorationColor |
Attribute type: TextDecorationColor, which represents the color to be used for drawing text decorations.
|
e_AttributeTypeTextDecorationThickness |
Attribute type: TextDecorationThickness, which represents the thickness of each line drawn as part of the text decoration.
|
e_AttributeTypeTextDecorationType |
Attribute type: TextDecorationType, which represents the text decoration, if any, to be applied to the element's text.
|
e_AttributeTypeRubyAlign |
Attribute type: RubyAlign, which represents the justification of the lines within a ruby assembly.
|
e_AttributeTypeRubyPosition |
Attribute type: RubyPosition, which represents the placement of the RT structure element relative to the RB element in a ruby assembly.
|
e_AttributeTypeGlyphOrientationVertical |
Attribute type: GlyphOrientationVertical, which specifies the orientation of glyphs when the inline-progression direction is top to bottom or bottom to top.
|
e_AttributeTypeColumnCount |
Attribute type: ColumnCount, which represents the number of columns in the content of the grouping element.
|
e_AttributeTypeColumnGap |
Attribute type: ColumnGap, which represents the desired space between adjacent columns, measured in the inline- progression direction.
|
e_AttributeTypeColumnWidths |
Attribute type: ColumnWidths, which represents the desired width of the columns, measured in the inline-progression direction.
|
e_AttributeTypeListNumbering |
Attribute type only for List: ListNumbering, which represents the numbering system to be used to generate the content of the Lbl (Label) elements in an autonumbered list, or the symbol used to identify each item in an unnumbered list.
|
e_AttributeTypeFieldRole |
Attribute type only for PrintField: Role, which represents the type of form field represented by this graphic.
|
e_AttributeTypeFieldChecked |
Attribute type only for PrintField: checked, which represents the state of a radio button or check box field.
|
e_AttributeTypeFieldDesc |
Attribute type only for PrintField: Desc, which represents the alternate name of the field, similar to the value supplied in the TU entry of the field dictionary for interactive fields.
|
e_AttributeTypeRowSpan |
Attribute type only for Table: RowSpan, which represents the number of rows in the enclosing table that are spanned by the cell.
|
e_AttributeTypeColSpan |
Attribute type only for Table: ColSpan, which represents the number of columns in the enclosing table that are spanned by the cell.
|
e_AttributeTypeTableHeaders |
(Currently, unsupported) Attribute type only for Table: Headers, which represents an array of element identifiers.
|
e_AttributeTypeTableHeaderScope |
Attribute type only for Table: Scope, which indicates whether the header cell applies to the rest of the cells in the row that contains it, the column that contains it, or both the row and the column that contain it.
|
e_AttributeTypeTableSummary |
Attribute type only for Table: Summary, which represents a summary of the table's purpose and structure, for use in non- visual rendering such as speech or braille.
|
e_AttributeTypeShort |
Attribute type: Short (PDF 2.0), which contains a short form of the content of a TH structure element's content.
|
e_AttributeTypeDirection |
(Reserved) Attribute type: Direction.
|
e_AttributeTypeABox |
(Reserved) Attribute type: ABox.
|
e_AttributeTypeVersion |
(Reserved) Attribute type: Version, which represents schema version of layout recognition engine.
|
Enumeration for element general layout attribute enum values.
Values of this enumeration should be used alone. This is the set of enum values for all attribute types whose value types are enum or an array of enum values.
Enumerator | |
---|---|
e_AttributeValueEnumInvalid |
Invalid enum value. |
e_AttributeValueEnumBlock |
Enum value: Block, which means to be stacked in the block-progression direction within an enclosing reference area or parent BLSE.
|
e_AttributeValueEnumInline |
Enum value: Inline, which means the placement for attributes Placement/RubyPosition.
|
e_AttributeValueEnumWarichu |
Enum value: Warichu, which means the RT and associated RP elements are to be formatted as a warichu, following the RB element.
|
e_AttributeValueEnumBefore |
Enum value: Before, which means the placement for attributes Placement/RubyPosition or alignment for attribute BlockAlign.
|
e_AttributeValueEnumAfter |
Enum value: After, which means the alignment for attribute BlockAlign or the placement for attribute RubyPosition.
|
e_AttributeValueEnumStart |
Enum value: Start, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
e_AttributeValueEnumEnd |
Enum value: End, which means the place for attribute Placement, or the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
e_AttributeValueEnumLrTb |
Enum value: LtTb, which means inline progression from left to right; block progression from top to bottom.
|
e_AttributeValueEnumRlTb |
Enum value: RlTb, which means inline progression from right to left; block progression from top to bottom.
|
e_AttributeValueEnumTbRl |
Enum value: TbRl, which means inline progression from top to bottom; block progression from right to left.
|
e_AttributeValueEnumTbLr |
Enum value: TbLr (PDF 2.0), which means inline progression from top to bottom; block progression from left to right.
|
e_AttributeValueEnumNone |
Enum value: None, which means no such attribute.
|
e_AttributeValueEnumHidden |
Enum value: Hidden, which is same as None except in terms of border conflict resolution for table elements.
|
e_AttributeValueEnumDotted |
Enum value: Dotten, which means the border is a series of dots.
|
e_AttributeValueEnumDashed |
Enum value: Dashed, which means the border is a series of short line segments.
|
e_AttributeValueEnumSolid |
Enum value: Solid, which means the border is a single line segment.
|
e_AttributeValueEnumDouble |
Enum value: Double, which means the border is two solid lines.
|
e_AttributeValueEnumGroove |
Enum value: Groove, which means the border looks as though it were carved into the canvas.
|
e_AttributeValueEnumRidge |
Enum value: Ridge, which means the border looks as though it were coming out of the canvas (the opposite of Groove).
|
e_AttributeValueEnumInset |
Enum value: Inset, which means the border makes the entire box look as though it were embedded in the canvas.
|
e_AttributeValueEnumOutset |
Enum value: Outset, which means the border makes the entire box look as though it were coming out of the canvas (the opposite of Inset).
|
e_AttributeValueEnumNormal |
Enum value: Normal, which means to adjust the line height to include any nonzero value specified for attribute BaselineShift .
|
e_AttributeValueEnumAuto |
Enum value: Auto.
|
e_AttributeValueEnumCenter |
Enum value: Center, which means the alignment for attributes TextAlign/InlineAlign/RubyAlign.
|
e_AttributeValueEnumJustify |
Enum value: Justify, which means the alignment for attributes TextAlign/BlockAlign/RubyAlign.
|
e_AttributeValueEnumMiddle |
Enum value: Middle, which means children are centered within the table cell.
|
e_AttributeValueEnumUnderline |
Enum value: Underline, which means a line below the text.
|
e_AttributeValueEnumOverline |
Enum value: Overline, which means a line above the text.
|
e_AttributeValueEnumLineThrough |
Enum value: LineThrough, which means a line through the middle of the text.
|
e_AttributeValueEnumDistribute |
Enum value: Distribute, which means the content is to be expanded to fill the available width in the inline-progression direction.
|
e_AttributeValueEnumDisc |
Enum value: Disc, which means solid circular bullet.
|
e_AttributeValueEnumCircle |
Enum value: Circle, which means open circular bullet.
|
e_AttributeValueEnumSquare |
Enum value: Square, which means solid square bullet.
|
e_AttributeValueEnumDecimal |
Enum value: Decimal, which means decimal arabic numerals (1-9, 10-99, ...).
|
e_AttributeValueEnumUpperRoman |
Enum value: UpperRoman, which means uppercase roman numerals (I, II, III, IV, ...).
|
e_AttributeValueEnumLowerRoman |
Enum value: LowerRoman, which means lowercase roman numerals (i, ii, iii, iv, ...).
|
e_AttributeValueEnumUpperAlpha |
Enum value: UpperAlpha, which means uppercase letters (A, B, C, ...).
|
e_AttributeValueEnumLowerAlpha |
Enum value: LowerAlpha, which means lowercase letters (a, b, c, ...).
|
e_AttributeValueEnumUnordered |
Enum value: Unordered (PDF 2.0), which means unordered list with unspecified bullets.
|
e_AttributeValueEnumOrdered |
Enum value: Ordered (PDF 2.0), which means ordered lists with unspecified numbering.
|
e_AttributeValueEnumFloat |
Enum value: float. |
e_AttributeValueEnumRB |
Enum value: rb, which means radio button.
|
e_AttributeValueEnumCB |
Enum value: cb, which means check box.
|
e_AttributeValueEnumPB |
Enum value: pb, which means push button.
|
e_AttributeValueEnumTV |
Enum value: tv, which means text-value field.
|
e_AttributeValueEnumOn |
Enum value: on, which means the state is on.
|
e_AttributeValueEnumOff |
Enum value: off, which means the state is off.
|
e_AttributeValueEnumNeutral |
Enum value: neutral, which means the state is neutral.
|
e_AttributeValueEnumRow |
Enum value: Row, which means row of a table.
|
e_AttributeValueEnumColumn |
Enum value: Row, which means column of a table.
|
e_AttributeValueEnumBoth |
Enum value: Row, which means both row and column of a table.
|
e_AttributeValueEnumLeft |
Enum value: Left, which means left edge of the page.
|
e_AttributeValueEnumTop |
Enum value: Top, which means top edge of the page.
|
e_AttributeValueEnumBottom |
Enum value: Bottom, which means bottom edge of the page.
|
e_AttributeValueEnumRight |
Enum value: Right, which means right edge of the page.
|
e_AttributeValueEnumPagination |
Enum value: Pagination, which means pagination artifacts. Ancillary page features such as running heads and folios (page numbers).
|
e_AttributeValueEnumLayout |
Enum value: Layout, which means layout artifacts. Purely cosmetic typographical or design elements such as footnote rules or background screens.
|
e_AttributeValueEnumPage |
Enum value: Page, which means page artifacts. Production aids extraneous to the document itself, such as cut marks and color bars.
|
e_AttributeValueEnumBackground |
Enum value: Background, which means background artifacts. Background artifacts typically serve as a background for content shown either on top of or placed adjacent to that background.
|
e_AttributeValueEnumHeader |
Enum value: Header. |
e_AttributeValueEnumFooter |
Enum value: Footer. |
e_AttributeValueEnumWatermark |
Enum value: Watermark. |
e_AttributeValueEnumPageNum |
Enum value: PageNum (PDF2.0). |
e_AttributeValueEnumBates |
Enum value: Bates (PDF2.0). |
e_AttributeValueEnumOther |
Enum value: Other (PDF 2.0).
|
Enumeration for value type of element general layout attribute.
Values of this enumeration should be used alone.
|
inline |
Constructor, with another structure element object.
[in] | other | Another structure element object. |
|
inline |
Constructor, with parent class object.
[in] | element | Parent class object. |
|
inline |
Get an ARGB value (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeARGB or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeARGBArray . For other value type, this function will return 0.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get value count of a specified attribute type.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
|
inline |
Get an structure element object (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeElement or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeElementArray . For other value type, this function will return a structure element whose function LRStructureElement::IsEmpty returns true.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get an enum value (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEnum or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEnumArray . For other value type, this function will return foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid .
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get a float value (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeFloat or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeFloatArray . For other value type, this function will return 0.0.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get an integer value (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeInt32 or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeInt32Array . For other value type, this function will return 0.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get a string value (specified by index) for specified attribute type.
This function is available for attributes whose value type is foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeWStr or foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeWStrArray . For other value type, this function will return an empty string.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
[in] | index | Index to specify which value will be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetAttributeValueCount . |
|
inline |
Get attribute value type for a specified attribute type.
[in] | type | Attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeRole and this should be one of these values. |
|
inline |
Get bounding box.
|
inline |
Get a child element by index.
[in] | index | Index of a child element to be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetChildCount . |
|
inline |
Get the count of children elements.
|
inline |
Get the parent element.
|
inline |
Get a supported attribute type by index.
[in] | index | Index for a supported attribute whose type is to be retrieved. Valid range: from 0 to (count-1). count is returned by function LRStructureElement.GetSupportedAttributeCount . |
|
inline |
Get supported attribute count.
|
inlinestatic |
Check whether input attribute value type represents an array.
[in] | type | Attribute value type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeValueType.e_AttributeValueTypeEmpty and this should be one of these values. |
|
inlinestatic |
Parse a string representation for attribute type and retrieve the enum value for this attribute type.
[in] | type_string | A string representation for a structure element attribute type. |
|
inlinestatic |
Convert the enum value of a specified attribute type to a short and memorable string (text) representation.
[in] | type | Enum value of a specified attribute type. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeType.e_AttributeTypeInvalid and this should be one of these values. |
|
inlinestatic |
Convert the enum value of a specified attribute value enum to a short and memorable string (text) representation.
[in] | type | Enum value of a specified attribute value enum. Please refer to values starting from foxit.addon.layoutrecognition.LRStructureElement.AttributeValueEnum.e_AttributeValueEnumInvalid and this should be one of these values. |