PDFsharp-net6

PdfNameDictionary

Namespace: PdfSharp.Pdf.Advanced

Represents the name dictionary.

public sealed class PdfNameDictionary : PdfSharp.Pdf.PdfDictionary, System.ICloneable, System.Collections.Generic.IEnumerable`1[[System.Collections.Generic.KeyValuePair`2[[System.String, System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e],[PdfSharp.Pdf.PdfItem, PdfSharp, Version=0.1.3.0, Culture=neutral, PublicKeyToken=null]], System.Private.CoreLib, Version=6.0.0.0, Culture=neutral, PublicKeyToken=7cec85d7bea7798e]], System.Collections.IEnumerable

Inheritance ObjectPdfItemPdfObjectPdfDictionaryPdfNameDictionary
Implements ICloneable, IEnumerable<KeyValuePair<String, PdfItem>>, IEnumerable

Properties

NameTree

Gets the named destinations

public PdfNameTreeNode NameTree { get; }

Property Value

PdfNameTreeNode

Elements

Gets the dictionary containing the elements of this dictionary.

public DictionaryElements Elements { get; }

Property Value

DictionaryElements

Stream

Gets or sets the PDF stream belonging to this dictionary. Returns null if the dictionary has no stream. To create the stream, call the CreateStream function.

public PdfStream Stream { get; set; }

Property Value

PdfStream

Owner

Gets the PdfDocument this object belongs to.

public PdfDocument Owner { get; }

Property Value

PdfDocument

IsIndirect

Indicates whether the object is an indirect object.

public bool IsIndirect { get; }

Property Value

Boolean

Internals

Gets the PdfInternals object of this document, that grants access to some internal structures which are not part of the public interface of PdfDocument.

public PdfObjectInternals Internals { get; }

Property Value

PdfObjectInternals

Reference

Gets the indirect reference of this object. If the value is null, this object is a direct object.

public PdfReference Reference { get; internal set; }

Property Value

PdfReference

ReferenceNotNull

Gets the indirect reference of this object. Throws if it is null.

public PdfReference ReferenceNotNull { get; }

Property Value

PdfReference

Exceptions

InvalidOperationException
The indirect reference must be not null here.

Constructors

PdfNameDictionary(PdfDocument)

Initializes a new instance of the PdfNameDictionary class.

public PdfNameDictionary(PdfDocument document)

Parameters

document PdfDocument

Methods

AddNamedDestination(String, Int32, PdfNamedDestinationParameters)

internal void AddNamedDestination(string destinationName, int destinationPage, PdfNamedDestinationParameters parameters)

Parameters

destinationName String

destinationPage Int32

parameters PdfNamedDestinationParameters

AddEmbeddedFile(String, Stream)

internal void AddEmbeddedFile(string name, Stream stream)

Parameters

name String

stream Stream