GrapeCity.Documents.Pdf.Structure.StructElement

StructElement Class

Represents a PDF tag (structure element) in a document's structure tree.

Inheritance

object

PdfWrapperBase

StructTreeItem

StructElement

Implements

IOwnedObject

IPdfDict

Namespace: GrapeCity.Documents.Pdf.Structure

Assembly: DS.Documents.Pdf.dll

Syntax

public class StructElement : StructTreeItem, IOwnedObject, IPdfDict

Public Class StructElement
    Inherits StructTreeItem
    Implements IOwnedObject, IPdfDict

Constructors

Name	Description
StructElement()	Initializes a new instance of the StructElement class.
StructElement(string)	Initializes a new instance of the StructElement class.

Properties

Name	Description
ActualText	Gets or sets a text that is an exact replacement for the structure element and its children. This replacement text (which should apply to as small a piece of content as possible) is useful when extracting a document’s content in support of accessibility to users with disabilities or for other purposes.
AlternateDescription	Gets or sets the alternate description of the structure element and its children in human-readable form, which is useful when extracting a document’s content in support of accessibility to users with disabilities or for other purposes.
AssociatedFiles	Gets the list of embedded files associated with this StructElement.
AttrClasses	Gets the collection of attribute classes associated with this element.
Attrs	Gets the collection of attributes associated with this structure element.
Children	Gets the collection of child StructElement object. This collection is a wrapper around the Items collection that iterates only over its elements of the type StructElement.
ContentItems	Gets the collection of ContentItemLink objects. This collection is a wrapper around the Items collection that iterates only over its elements of the type ContentItemLink.
DefaultPage	Gets or sets a Page object used as the default page for the content items owned by this StructElement.
ExpandedAbbreviation	Gets or sets the expanded form of an abbreviation.
HasAttrClasses	Gets a value indicating whether the AttrClasses collection contains any items.
HasAttrs	Gets a value indicating whether Attrs collection contains any items.
HasChildren	Gets a value indicating whether the Children collection contains any items.
HasContentItems	Gets a value indicating whether the ContentItems collection contains any items.
HasItems	Gets a value indicating whether the Items collection contains any items.
ID	Gets or sets the element identifier, a byte array designating this structure element. The value must be unique among all elements in the document’s structure hierarchy.
Items	Gets the collection of nested StructTreeItem objects.
Parent	Gets the parent StructElement object.
PdfObject	Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject.
Revision	Gets or sets the current revision number of this structure element.
Title	Gets or sets the title of the structure element, which is a text string representing it in human-readable form. The title should characterize the specific structure element, such as Chapter 1, rather than merely a generic element type, such as Chapter.
Type	Gets or sets the structure type, which is a string identifying the nature of the structure element and its role within the document, such as chapter, paragraph, or footnote.