PdfOutlineCollection Class

Terminal Works - PDF Printing.Net Library

Represents a collection of outlines.

Inheritance Hierarchy

SystemObject
  PdfEdit.PdfPdfItem
    PdfEdit.PdfPdfObject
      PdfEdit.PdfPdfOutlineCollection

Namespace: PdfEdit.Pdf
Assembly: PdfPrintingNet (in PdfPrintingNet.dll) Version: 5.2.1.0 (5.2.1.0)

Syntax

C++

Copy

public class PdfOutlineCollection : PdfObject, 
	ICollection<PdfOutline>, IEnumerable<PdfOutline>, IEnumerable, 
	IList<PdfOutline>

Public Class PdfOutlineCollection
	Inherits PdfObject
	Implements ICollection(Of PdfOutline), IEnumerable(Of PdfOutline), 
	IEnumerable, IList(Of PdfOutline)

public ref class PdfOutlineCollection : public PdfObject, 
	ICollection<PdfOutline^>, IEnumerable<PdfOutline^>, IEnumerable, 
	IList<PdfOutline^>

The PdfOutlineCollection type exposes the following members.

Methods

	Name	Description
	Add(PdfOutline)	Adds the specified outline.
	Add(String, PdfPage)	Creates a PdfOutline and adds it into the outline collection.
	Add(String, PdfPage, Boolean)	Adds the specified outline entry.
	Add(String, PdfPage, Boolean, PdfOutlineStyle)	Adds the specified outline entry.
	Add(String, PdfPage, Boolean, PdfOutlineStyle, XColor)	Adds the specified outline entry.
	Clear	Removes all elements form the collection.
	Clone	Creates a copy of this object. The clone does not belong to a document, i.e. its owner and its iref are null. (Inherited from PdfObject.)
	Contains	Determines whether the specified element is in the collection.
	Copy	Implements the copy mechanism. Must be overridden in derived classes. (Inherited from PdfObject.)
	CopyTo	Copies the collection to an array, starting at the specified index of the target array.
	Equals	Determines whether the specified Object is equal to the current Object. (Inherited from Object.)
	Finalize	Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection. (Inherited from Object.)
	GetEnumerator	Returns an enumerator that iterates through the outline collection.
	GetHashCode	Serves as a hash function for a particular type. (Inherited from Object.)
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	IndexOf	Gets the index of the specified item.
	Insert	Inserts the item at the specified index.
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	Remove	Removes the first occurrence of a specific item from the collection.
	RemoveAt	Removes the outline item at the specified index.
	ToString	Returns a String that represents the current Object. (Inherited from Object.)

Top

Properties

	Name	Description
	Count	Gets the number of entries in this collection.
	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. (Inherited from PdfObject.)
	IsIndirect	Indicates whether the object is an indirect object. (Inherited from PdfObject.)
	IsReadOnly	Returns false.
	Item	Gets the PdfOutline at the specified index.
	Owner	Gets the PdfDocument this object belongs to. (Inherited from PdfObject.)
	Reference	Gets the indirect reference of this object. If the value is null, this object is a direct object. (Inherited from PdfObject.)

Top

Reference

PdfEdit.Pdf Namespace