Class MarkedContentElement

Namespace

UglyToad.PdfPig.Content

Assembly

UglyToad.PdfPig.dll

A marked content element can be used to provide application specific data in the page's content stream. Interpretation of the marked content is outside of the PDF specification.

public class MarkedContentElement

Inheritance

object

MarkedContentElement

Derived

ArtifactMarkedContentElement

Inherited Members

object.GetType()

object.MemberwiseClone()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

MarkedContentElement(int, NameToken, DictionaryToken, string, string, string, string, bool, IReadOnlyList<MarkedContentElement>, IReadOnlyList<Letter>, IReadOnlyList<PdfPath>, IReadOnlyList<IPdfImage>, int)

Create a new MarkedContentElement.

public MarkedContentElement(int markedContentIdentifier, NameToken tag, DictionaryToken properties, string language, string actualText, string alternateDescription, string expandedForm, bool isArtifact, IReadOnlyList<MarkedContentElement> children, IReadOnlyList<Letter> letters, IReadOnlyList<PdfPath> paths, IReadOnlyList<IPdfImage> images, int index)

Parameters

markedContentIdentifier int

tag NameToken

properties DictionaryToken

language string

actualText string

alternateDescription string

expandedForm string

isArtifact bool

children IReadOnlyList<MarkedContentElement>

letters IReadOnlyList<Letter>

paths IReadOnlyList<PdfPath>

images IReadOnlyList<IPdfImage>

index int

Properties

ActualText

The replacement text.

public string ActualText { get; }

Property Value

string

AlternateDescription

The alternate description.

public string AlternateDescription { get; }

Property Value

string

Children

Child contents.

public IReadOnlyList<MarkedContentElement> Children { get; }

Property Value

IReadOnlyList<MarkedContentElement>

ExpandedForm

The abbreviation expansion text.

public string ExpandedForm { get; }

Property Value

string

Images

Images contained in this marked content.

public IReadOnlyList<IPdfImage> Images { get; }

Property Value

IReadOnlyList<IPdfImage>

Index

The index of this marked content element in the set of marked content in the page. Children marked content elements will have the same index as the parent.

public int Index { get; }

Property Value

int

IsArtifact

Is the marked content an artifact, see ArtifactMarkedContentElement.

public bool IsArtifact { get; }

Property Value

bool

Language

The natural language specification.

public string Language { get; }

Property Value

string

Letters

Letters contained in this marked content.

public IReadOnlyList<Letter> Letters { get; }

Property Value

IReadOnlyList<Letter>

MarkedContentIdentifier

Marked-content identifier.

public int MarkedContentIdentifier { get; }

Property Value

int

Paths

Paths contained in this marked content.

public IReadOnlyList<PdfPath> Paths { get; }

Property Value

IReadOnlyList<PdfPath>

Properties

The properties for this element.

public DictionaryToken Properties { get; }

Property Value

DictionaryToken

Tag

A name indicating the role or significance of the point.

public string Tag { get; }

Property Value

string

Methods

ToString()

public override string ToString()

Returns

string