PdfSharp-WPF  1.31.7289
PdfSharp.Pdf.PdfOutline Class Reference

Represents an outline item in the outlines tree. An outline is also knows as a bookmark. More...

Inheritance diagram for PdfSharp.Pdf.PdfOutline:
PdfSharp.Pdf.PdfDictionary PdfSharp.Pdf.PdfObject PdfSharp.Pdf.PdfItem

Classes

class  Keys
 Predefined keys of this dictionary.
 
class  PdfOutlineCollection
 Represents a collection of outlines. More...
 

Public Member Functions

 PdfOutline ()
 Initializes a new instance of the PdfOutline class. More...
 
 PdfOutline (PdfDictionary dict)
 Initializes a new instance from an existing dictionary. Used for object type transformation. More...
 
 PdfOutline (string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style, XColor textColor)
 Initializes a new instance of the PdfOutline class. More...
 
 PdfOutline (string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style)
 Initializes a new instance of the PdfOutline class. More...
 
 PdfOutline (string title, PdfPage destinationPage, bool opened)
 Initializes a new instance of the PdfOutline class. More...
 
 PdfOutline (string title, PdfPage destinationPage)
 Initializes a new instance of the PdfOutline class. More...
 
- Public Member Functions inherited from PdfSharp.Pdf.PdfDictionary
 PdfDictionary ()
 Initializes a new instance of the PdfDictionary class. More...
 
 PdfDictionary (PdfDocument document)
 Initializes a new instance of the PdfDictionary class. More...
 
new PdfDictionary Clone ()
 Creates a copy of this dictionary. Direct values are deep copied. Indirect references are not modified. More...
 
IEnumerator GetEnumerator ()
 Returns an enumerator that iterates through a collection. More...
 
override string ToString ()
 Returns a string with the content of this object in a readable form. Useful for debugging purposes only. More...
 
PdfStream CreateStream (byte[] value)
 Creates the stream of this dictionary and initializes it with the specified byte array. The function must not be called if the dictionary already has a stream. More...
 
- Public Member Functions inherited from PdfSharp.Pdf.PdfObject
new PdfObject Clone ()
 Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. More...
 
- Public Member Functions inherited from PdfSharp.Pdf.PdfItem
PdfItem Clone ()
 Creates a copy of this object. More...
 

Properties

string Title [get, set]
 Gets or sets the title. More...
 
PdfPage DestinationPage [get, set]
 Gets or sets the destination page. More...
 
bool Opened [get, set]
 Gets or sets whether the outline item is opened (or expanded). More...
 
PdfOutlineStyle Style [get, set]
 Gets or sets the style. More...
 
XColor TextColor [get, set]
 Gets or sets the color of the text. More...
 
PdfOutlineCollection Outlines [get]
 Gets the outline collection of this node. More...
 
- Properties inherited from PdfSharp.Pdf.PdfDictionary
DictionaryElements Elements [get]
 Gets the hashtable containing the elements of this dictionary. More...
 
PdfStream Stream [get, set]
 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. More...
 
- Properties inherited from PdfSharp.Pdf.PdfObject
virtual PdfDocument Owner [get]
 Gets the PdfDocument this object belongs to. More...
 
bool IsIndirect [get]
 Indicates whether the object is an indirect object. More...
 
PdfObjectInternals Internals [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. More...
 
PdfReference Reference [get, set]
 Gets the indirect reference of this object. If the value is null, this object is a direct object. More...
 

Additional Inherited Members

- Protected Member Functions inherited from PdfSharp.Pdf.PdfDictionary
 PdfDictionary (PdfDictionary dict)
 Initializes a new instance from an existing dictionary. Used for object type transformation. More...
 
override object Copy ()
 This function is useful for importing objects from external documents. The returned object is not yet complete. irefs refer to external objects and directed objects are cloned but their document property is null. A cloned dictionary or array needs a 'fix-up' to be a valid object. More...
 
- Protected Member Functions inherited from PdfSharp.Pdf.PdfObject
 PdfObject ()
 Initializes a new instance of the PdfObject class. More...
 
 PdfObject (PdfDocument document)
 Initializes a new instance of the PdfObject class. More...
 
 PdfObject (PdfObject obj)
 Initializes a new instance from an existing object. Used for object type transformation. More...
 
override object Copy ()
 Implements the copy mechanism. Must be overridden in derived classes. More...
 
- Protected Attributes inherited from PdfSharp.Pdf.PdfDictionary
DictionaryElements elements
 The elements of the dictionary. More...
 

Detailed Description

Represents an outline item in the outlines tree. An outline is also knows as a bookmark.

Constructor & Destructor Documentation

◆ PdfOutline() [1/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( )

Initializes a new instance of the PdfOutline class.

◆ PdfOutline() [2/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( PdfDictionary  dict)

Initializes a new instance from an existing dictionary. Used for object type transformation.

◆ PdfOutline() [3/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( string  title,
PdfPage  destinationPage,
bool  opened,
PdfOutlineStyle  style,
XColor  textColor 
)

Initializes a new instance of the PdfOutline class.

Parameters
titleThe outline text.
destinationPageThe destination page.
openedSpecifies whether the node is displayed expanded (opened) or collapsed.
styleThe font style used to draw the outline text.
textColorThe color used to draw the outline text.

◆ PdfOutline() [4/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( string  title,
PdfPage  destinationPage,
bool  opened,
PdfOutlineStyle  style 
)

Initializes a new instance of the PdfOutline class.

Parameters
titleThe outline text.
destinationPageThe destination page.
openedSpecifies whether the node is displayed expanded (opened) or collapsed.
styleThe font style used to draw the outline text.

◆ PdfOutline() [5/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( string  title,
PdfPage  destinationPage,
bool  opened 
)

Initializes a new instance of the PdfOutline class.

Parameters
titleThe outline text.
destinationPageThe destination page.
openedSpecifies whether the node is displayed expanded (opened) or collapsed.

◆ PdfOutline() [6/6]

PdfSharp.Pdf.PdfOutline.PdfOutline ( string  title,
PdfPage  destinationPage 
)

Initializes a new instance of the PdfOutline class.

Parameters
titleThe outline text.
destinationPageThe destination page.

Property Documentation

◆ DestinationPage

PdfPage PdfSharp.Pdf.PdfOutline.DestinationPage
getset

Gets or sets the destination page.

◆ Opened

bool PdfSharp.Pdf.PdfOutline.Opened
getset

Gets or sets whether the outline item is opened (or expanded).

◆ Outlines

PdfOutlineCollection PdfSharp.Pdf.PdfOutline.Outlines
get

Gets the outline collection of this node.

◆ Style

PdfOutlineStyle PdfSharp.Pdf.PdfOutline.Style
getset

Gets or sets the style.

◆ TextColor

XColor PdfSharp.Pdf.PdfOutline.TextColor
getset

Gets or sets the color of the text.

The color of the text.

◆ Title

string PdfSharp.Pdf.PdfOutline.Title
getset

Gets or sets the title.


The documentation for this class was generated from the following file: