[]
产品首页 在线Demo 产品文档 API 参考 技术社区
立即试用
(Showing Draft Content)

GrapeCity.Documents.Pdf.Structure.StructElement

Class StructElement

Namespace
GrapeCity.Documents.Pdf.Structure
Assembly
GcDocs.Pdf.dll

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

public class StructElement : StructTreeItem, IOwnedObject, IPdfDict
Inheritance
object
StructElement
Implements
Inherited Members
object.ToString()
object.Equals(object)
object.Equals(object, object)
object.ReferenceEquals(object, object)
object.GetHashCode()
object.GetType()
object.MemberwiseClone()
Extension Methods

Constructors

StructElement()

Initializes a new instance of the StructElement class.

public StructElement()

StructElement(string)

Initializes a new instance of the StructElement class.

public StructElement(string type)

Parameters

type string

The element's type.

Properties

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.

public string ActualText { get; set; }

Property Value

string

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.

public string AlternateDescription { get; set; }

Property Value

string

AssociatedFiles

Gets the list of embedded files associated with this StructElement.

public AssociatedFiles AssociatedFiles { get; }

Property Value

AssociatedFiles

AttrClasses

Gets the collection of attribute classes associated with this element.

public AttrClsRevisionCollection AttrClasses { get; }

Property Value

AttrClsRevisionCollection

Attrs

Gets the collection of attributes associated with this structure element.

public AttrRevisionCollection Attrs { get; }

Property Value

AttrRevisionCollection

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. 

public StructElementCollection Children { get; }

Property Value

StructElementCollection

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. 

public ContentItemLinkCollection ContentItems { get; }

Property Value

ContentItemLinkCollection

DefaultPage

Gets or sets a Page object used as the default page for the content items owned by this StructElement.

public Page DefaultPage { get; set; }

Property Value

Page

ExpandedAbbreviation

Gets or sets the expanded form of an abbreviation.

public string ExpandedAbbreviation { get; set; }

Property Value

string

HasAttrClasses

Gets a value indicating whether the AttrClasses collection contains any items.

public bool HasAttrClasses { get; }

Property Value

bool

HasAttrs

Gets a value indicating whether Attrs collection contains any items.

public bool HasAttrs { get; }

Property Value

bool

HasChildren

Gets a value indicating whether the Children collection contains any items.

public bool HasChildren { get; }

Property Value

bool

HasContentItems

Gets a value indicating whether the ContentItems collection contains any items.

public bool HasContentItems { get; }

Property Value

bool

HasItems

Gets a value indicating whether the Items collection contains any items.

public bool HasItems { get; }

Property Value

bool

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.

public IPdfString ID { get; set; }

Property Value

IPdfString

Items

Gets the collection of nested StructTreeItem objects.

public StructTreeItemCollection Items { get; }

Property Value

StructTreeItemCollection

Parent

Gets the parent StructElement object.

public StructElement Parent { get; }

Property Value

StructElement

PdfObject

Gets the underlying GrapeCity.Documents.Pdf.Spec.IPdfObject.

public override IPdfObject PdfObject { get; }

Property Value

GrapeCity.Documents.Pdf.Spec.IPdfObject

Revision

Gets or sets the current revision number of this structure element.

public int Revision { get; set; }

Property Value

int

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.

public string Title { get; set; }

Property Value

string

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.

public string Type { get; set; }

Property Value

string