Class PdfEmbeddedGoToAction

Namespace

PdfSharp.Pdf.Actions

Assembly

PdfSharp.dll

Represents a PDF Embedded Goto action.

public sealed class PdfEmbeddedGoToAction : PdfAction, ICloneable, IEnumerable<KeyValuePair<string, PdfItem?>>, IEnumerable

Inheritance

object

PdfItem

PdfObject

PdfDictionary

PdfAction

PdfEmbeddedGoToAction

Implements

ICloneable

IEnumerable<KeyValuePair<string, PdfItem>>

IEnumerable

Inherited Members

PdfDictionary.Clone()

PdfDictionary.GetEnumerator()

PdfDictionary.ToString()

PdfDictionary.CreateStream(byte[])

PdfDictionary.Elements

PdfDictionary.Stream

PdfObject.Owner

PdfObject.Comment

PdfObject.IsIndirect

PdfObject.Internals

PdfObject.Reference

PdfObject.ReferenceNotNull

object.GetType()

object.Equals(object)

object.Equals(object, object)

object.ReferenceEquals(object, object)

object.GetHashCode()

Constructors

PdfEmbeddedGoToAction()

Initializes a new instance of the PdfEmbeddedGoToAction class.

public PdfEmbeddedGoToAction()

PdfEmbeddedGoToAction(PdfDocument)

Initializes a new instance of the PdfEmbeddedGoToAction class.

public PdfEmbeddedGoToAction(PdfDocument document)

Parameters

document PdfDocument

The document that owns this object.

Fields

ParentString

Path segment string used to move to the parent document.

public const string ParentString = ".."

Field Value

string

Separator

Separator for splitting destination path segments ans destination name.

public const char Separator = '\\'

Field Value

char

Methods

CreatePdfEmbeddedGoToAction(string, bool?)

Creates a link to an embedded document.

public static PdfEmbeddedGoToAction CreatePdfEmbeddedGoToAction(string destinationPath, bool? newWindow = null)

Parameters

destinationPath string

The path to the named destination through the embedded documents. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the current (root or embedded) document to the embedded document holding the destination. ".." references to the parent, other strings refer to a child with this name in the EmbeddedFiles name dictionary.

newWindow bool?

True, if the destination document shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

PdfEmbeddedGoToAction

CreatePdfEmbeddedGoToAction(string?, string, bool?)

Creates a link to an embedded document in another document.

public static PdfEmbeddedGoToAction CreatePdfEmbeddedGoToAction(string? documentPath, string destinationPath, bool? newWindow = null)

Parameters

documentPath string

The path to the target document.

destinationPath string

The path to the named destination through the embedded documents in the target document. The path is separated by '' and the last segment is the name of the named destination. The other segments describe the route from the root document to the embedded document. Each segment name refers to a child with this name in the EmbeddedFiles name dictionary.

newWindow bool?

True, if the destination document shall be opened in a new window. If not set, the viewer application should behave in accordance with the current user preference.

Returns

PdfEmbeddedGoToAction