PdfSharp.Pdf.PdfOutline.PdfOutlineCollection Class Reference
Represents a collection of outlines. More...
Inheritance diagram for PdfSharp.Pdf.PdfOutline.PdfOutlineCollection:
Public Member Functions | |
| void | Add (PdfOutline outline) |
| Adds the specified outline. More... | |
| PdfOutline | Add (string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style, XColor textColor) |
| Adds the specified outline entry. More... | |
| PdfOutline | Add (string title, PdfPage destinationPage, bool opened, PdfOutlineStyle style) |
| Adds the specified outline entry. More... | |
| PdfOutline | Add (string title, PdfPage destinationPage, bool opened) |
| Adds the specified outline entry. More... | |
| PdfOutline | Add (string title, PdfPage destinationPage) |
| Adds the specified outline entry. More... | |
| int | IndexOf (PdfOutline item) |
| Gets the index of the specified outline. More... | |
| IEnumerator | GetEnumerator () |
| Returns an enumerator that iterates through a collection. 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 | |
| bool | HasOutline [get] |
| Indicates whether the outline has at least one entry. More... | |
| int | Count [get] |
| Gets the number of entries in this collection. More... | |
| PdfOutline | this[int index] [get] |
| Gets the PdfSharp.Pdf.PdfOutline at the specified index. 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.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... | |
Detailed Description
Represents a collection of outlines.
Member Function Documentation
◆ Add() [1/5]
| void PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.Add | ( | PdfOutline | outline | ) |
Adds the specified outline.
◆ Add() [2/5]
| PdfOutline PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.Add | ( | string | title, |
| PdfPage | destinationPage | ||
| ) |
Adds the specified outline entry.
- Parameters
-
title The outline text. destinationPage The destination page.
◆ Add() [3/5]
| PdfOutline PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.Add | ( | string | title, |
| PdfPage | destinationPage, | ||
| bool | opened | ||
| ) |
Adds the specified outline entry.
- Parameters
-
title The outline text. destinationPage The destination page. opened Specifies whether the node is displayed expanded (opened) or collapsed.
◆ Add() [4/5]
| PdfOutline PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.Add | ( | string | title, |
| PdfPage | destinationPage, | ||
| bool | opened, | ||
| PdfOutlineStyle | style | ||
| ) |
Adds the specified outline entry.
- Parameters
-
title The outline text. destinationPage The destination page. opened Specifies whether the node is displayed expanded (opened) or collapsed. style The font style used to draw the outline text.
◆ Add() [5/5]
| PdfOutline PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.Add | ( | string | title, |
| PdfPage | destinationPage, | ||
| bool | opened, | ||
| PdfOutlineStyle | style, | ||
| XColor | textColor | ||
| ) |
Adds the specified outline entry.
- Parameters
-
title The outline text. destinationPage The destination page. opened Specifies whether the node is displayed expanded (opened) or collapsed. style The font style used to draw the outline text. textColor The color used to draw the outline text.
◆ GetEnumerator()
| IEnumerator PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.GetEnumerator | ( | ) |
Returns an enumerator that iterates through a collection.
◆ IndexOf()
| int PdfSharp.Pdf.PdfOutline.PdfOutlineCollection.IndexOf | ( | PdfOutline | item | ) |
Gets the index of the specified outline.
Property Documentation
◆ Count
|
get |
Gets the number of entries in this collection.
◆ HasOutline
|
get |
Indicates whether the outline has at least one entry.
◆ this[int index]
|
get |
Gets the PdfSharp.Pdf.PdfOutline at the specified index.
The documentation for this class was generated from the following file:
- PdfSharp.Pdf/PdfOutline.cs
