Class ContentTag

Namespace

Rustaveli.Pdf

Assembly

Rustaveli.Pdf.dll

The part content plays in a document's structure — a heading, a paragraph, a figure and what it shows — as a tagged PDF records it for screen readers, reflow and search.

public sealed class ContentTag

Inheritance

object

ContentTag

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

Remarks

Tags are the standard structure types of PDF, named here in words: Paragraph is P, Heading(int) of level 1 is H1. They are written only when the export is tagged; otherwise tagged content is drawn exactly as it would be untagged.

Properties

AlternateText

What a figure or formula shows, read in its place; null for other tags.

public string? AlternateText { get; }

Property Value

string

Article

A piece complete in itself, such as a story in a newspaper.

public static ContentTag Article { get; }

Property Value

ContentTag

BlockQuote

One or more paragraphs quoted from elsewhere.

public static ContentTag BlockQuote { get; }

Property Value

ContentTag

Caption

The caption of a figure or table.

public static ContentTag Caption { get; }

Property Value

ContentTag

Code

Computer code.

public static ContentTag Code { get; }

Property Value

ContentTag

Contents

A table of contents, made of ContentsEntry content and nested tables of contents.

public static ContentTag Contents { get; }

Property Value

ContentTag

ContentsEntry

One entry in a table of contents.

public static ContentTag ContentsEntry { get; }

Property Value

ContentTag

Division

A group of content with no more particular part to play.

public static ContentTag Division { get; }

Property Value

ContentTag

Expansion

The words an abbreviation stands for, read in its place; null for other tags.

public string? Expansion { get; }

Property Value

string

Index

An index of terms and where they appear.

public static ContentTag Index { get; }

Property Value

ContentTag

List

A list, made of ListItem content. Lists composed as lists are tagged without asking.

public static ContentTag List { get; }

Property Value

ContentTag

ListBody

The content of a list item, beside its label.

public static ContentTag ListBody { get; }

Property Value

ContentTag

ListItem

One item of a list: its ListLabel and its ListBody.

public static ContentTag ListItem { get; }

Property Value

ContentTag

ListLabel

The bullet or number of a list item.

public static ContentTag ListLabel { get; }

Property Value

ContentTag

Note

A footnote or endnote.

public static ContentTag Note { get; }

Property Value

ContentTag

Paragraph

A paragraph. Text that is not inside other tagged content is tagged a paragraph without asking.

public static ContentTag Paragraph { get; }

Property Value

ContentTag

Quote

Words quoted within a paragraph.

public static ContentTag Quote { get; }

Property Value

ContentTag

Role

The name PDF gives the tag, such as P, H1 or Figure.

public string Role { get; }

Property Value

string

Section

A section of a chapter or article, usually opening with a heading.

public static ContentTag Section { get; }

Property Value

ContentTag

Span

Words within a paragraph set apart for no more particular reason, such as a change of language.

public static ContentTag Span { get; }

Property Value

ContentTag

Table

A table of data. A table composed inside is tagged row by row and cell by cell, its header rows as headings of their columns.

public static ContentTag Table { get; }

Property Value

ContentTag

Methods

Abbreviation(string)

An abbreviation, read as the words in expansion.

public static ContentTag Abbreviation(string expansion)

Parameters

expansion string

Returns

ContentTag

Figure(string)

A picture, chart or diagram, read as alternateText. Everything drawn inside belongs to it; images and drawings outside any figure are taken as decoration.

public static ContentTag Figure(string alternateText)

Parameters

alternateText string

Returns

ContentTag

Formula(string)

A mathematical formula, read as alternateText.

public static ContentTag Formula(string alternateText)

Parameters

alternateText string

Returns

ContentTag

Heading(int)

A heading, from level 1 for the outermost to level 6.

public static ContentTag Heading(int level)

Parameters

level int

Returns

ContentTag

ToString()

Returns a string that represents the current object.

public override string ToString()

Returns

string

A string that represents the current object.