Namespace: PdfSharp.Pdf.Actions
Represents a PDF Embedded Goto action.
public sealed class PdfEmbeddedGoToAction : PdfAction, 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 Object → PdfItem → PdfObject → PdfDictionary → PdfAction → PdfEmbeddedGoToAction
Implements ICloneable, IEnumerable<KeyValuePair<String, PdfItem>>, IEnumerable
Separator for splitting destination path segments ans destination name.
public static char Separator;
Path segment string used to move to the parent document.
public static string ParentString;
Gets the dictionary containing the elements of this dictionary.
public DictionaryElements Elements { get; }
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; }
Gets the PdfDocument this object belongs to.
public PdfDocument Owner { get; }
Indicates whether the object is an indirect object.
public bool IsIndirect { get; }
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; }
Gets the indirect reference of this object. If the value is null, this object is a direct object.
public PdfReference Reference { get; internal set; }
Gets the indirect reference of this object. Throws if it is null.
public PdfReference ReferenceNotNull { get; }
InvalidOperationException
The indirect reference must be not null here.
Initializes a new instance of the PdfEmbeddedGoToAction class.
public PdfEmbeddedGoToAction()
Initializes a new instance of the PdfEmbeddedGoToAction class.
public PdfEmbeddedGoToAction(PdfDocument document)
document
PdfDocument
The document that owns this object.
Creates a link to an embedded document.
public static PdfEmbeddedGoToAction CreatePdfEmbeddedGoToAction(string destinationPath, Nullable<bool> newWindow)
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
Nullable<Boolean>
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.
Creates a link to an embedded document in another document.
public static PdfEmbeddedGoToAction CreatePdfEmbeddedGoToAction(string documentPath, string destinationPath, Nullable<bool> newWindow)
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
Nullable<Boolean>
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.
internal void WriteObject(PdfWriter writer)
writer
PdfWriter