TaggedContent

TaggedContent

Overview

TaggedContent is a class in Aspose.PDF FOSS for .NET. Inherits from: ITaggedContent.

Provides access to tagged PDF metadata (title, language) and the logical structure tree.

This class declares 42 methods for TaggedContent objects in .NET programs. Available methods include: CreateAnnotElement, CreateArtElement, CreateBibEntryElement, CreateBlockQuoteElement, CreateCaptionElement, CreateCodeElement, CreateDivElement, CreateFigureElement, CreateFormElement, CreateFormulaElement, CreateHeaderElement, CreateIndexElement, and 29 additional methods. Public members are accessible to any .NET application after installing the Aspose.PDF FOSS for .NET package. Properties: Language, RootElement, StructTreeRoot, StructTreeRootElement, StructureTextState, Title.

Properties

NameTypeAccessDescription
Titlestring?ReadThe document title (from the Info dictionary).
Languagestring?ReadThe document language (BCP 47 tag, from the catalog /Lang entry).
StructTreeRootAspose.Pdf.Tagged.StructTreeRoot?ReadRead-only view of the document’s structure-tree root (/StructTreeRoot), or null when the document is not tagged.
RootElementLS.StructureElementReadThe first top-level structure element under StructTreeRootElement (typically the auto-generated Document element).
StructTreeRootElementLS.StructTreeRootElementReadThe /StructTreeRoot wrapper hosting the document’s structure tree.
StructureTextStateLS.StructureTextStateReadDefault text-state used by inline structure elements that don’t specify their own.

Methods

SignatureDescription
SetTitle(title: string)Set the document title in the information dictionary.
SetLanguage(language: string)Set the document language (BCP 47 tag, e.g.
CreateAnnotElement()Create a TaggedContent instance. Returns null if the document is not tagged.
CreateArtElement()Calls CreateArtElement on this TaggedContent instance.
CreateBibEntryElement()Calls CreateBibEntryElement on this TaggedContent instance.
CreateBlockQuoteElement()Calls CreateBlockQuoteElement on this TaggedContent instance.
CreateCaptionElement()Calls CreateCaptionElement on this TaggedContent instance.
CreateCodeElement()Calls CreateCodeElement on this TaggedContent instance.
CreateDivElement()Calls CreateDivElement on this TaggedContent instance.
CreateFigureElement()Creates a figure element (/Figure).
CreateFormElement()Creates a form element (/Form).
CreateFormulaElement()Create a TaggedContent instance for a new (potentially untagged) document. Ensures the document has MarkInfo and StructTreeRoot. Creates an in-memory root element that does not depend on the PDF reader.
CreateHeaderElement()Creates a heading element without a level (/H).
CreateHeaderElement(level: int)Creates a heading element of the given level (/H1, /H2 …); a level of 0 or less gives /H.
CreateIndexElement()Calls CreateIndexElement on this TaggedContent instance.
CreateLinkElement()Creates a link element (/Link).
CreateListElement()Creates a list element (/L).
CreateListLBodyElement()Calls CreateListLBodyElement on this TaggedContent instance.
CreateListLIElement()Creates a list-item element (/LI).
CreateListLblElement()Calls CreateListLblElement on this TaggedContent instance.
CreateNonStructElement()Calls CreateNonStructElement on this TaggedContent instance.
CreateNoteElement()Creates a note element (/Note).
CreateParagraphElement()Creates a paragraph element (/P).
CreatePartElement()Calls CreatePartElement on this TaggedContent instance.
CreatePrivateElement()Calls CreatePrivateElement on this TaggedContent instance.
CreateQuoteElement()Creates an inline quotation element (/Quote).
CreateReferenceElement()Calls CreateReferenceElement on this TaggedContent instance.
CreateRubyElement()The document title (from the Info dictionary).
CreateSectElement()Creates a section element (/Sect).
CreateSpanElement()Creates a span element (/Span).
CreateTOCElement()Creates a table-of-contents element (/TOC).
CreateTOCIElement()Creates a table-of-contents item element (/TOCI).
CreateTableElement()Creates a table element (/Table).
CreateTableTBodyElement()Set the document title in the information dictionary.
CreateTableTDElement()Calls CreateTableTDElement on this TaggedContent instance.
CreateTableTFootElement()Calls CreateTableTFootElement on this TaggedContent instance.
CreateTableTHElement()Calls CreateTableTHElement on this TaggedContent instance.
CreateTableTHeadElement()Calls CreateTableTHeadElement on this TaggedContent instance.
CreateTableTRElement()Calls CreateTableTRElement on this TaggedContent instance.
CreateWarichuElement()Calls CreateWarichuElement on this TaggedContent instance.
PreSave()Prepare the in-memory tree for serialisation.
Save()Flush the in-memory tree to the document’s StructTreeRoot dictionary so the next file save embeds the updated structure.

See Also

 English