Represents the pages of the document. More...

Inheritance diagram for PdfSharp.Pdf.PdfPages:

Classes
class	Keys
	Predefined keys of this dictionary.

Public Member Functions
PdfPage	Add ()
	Creates a new PdfPage, adds it to this document, and returns it. More...

PdfPage	Add (PdfPage page)
	Adds the specified PdfPage to this document and maybe returns a new PdfPage object. The value returned is a new object if the added page comes from a foreign document. More...

PdfPage	Insert (int index)
	Creates a new PdfPage, inserts it at the specified position into this document, and returns it. More...

PdfPage	Insert (int index, PdfPage page)
	Inserts the specified PdfPage at the specified position to this document and maybe returns a new PdfPage object. The value returned is a new object if the inserted page comes from a foreign document. More...

void	Remove (PdfPage page)
	Removes the specified page from the document. More...

void	RemoveAt (int index)
	Removes the specified page from the document. More...

void	MovePage (int oldIndex, int newIndex)
	Moves a page within the page sequence. More...

new IEnumerator	GetEnumerator ()
	Gets the enumerator. 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
int	Count `[get]`
	Gets the number of pages. More...

PdfPage	this[int index] `[get]`
	Gets the page with the specified index. More...

PdfArray	PagesArray `[get]`
	Gets a PdfArray containing all pages of this document. The array must not be modified. 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 the pages of the document.

Member Function Documentation

◆ Add() [1/2]

PdfPage PdfSharp.Pdf.PdfPages.Add ( )

Creates a new PdfPage, adds it to this document, and returns it.

◆ Add() [2/2]

PdfPage PdfSharp.Pdf.PdfPages.Add ( PdfPage page )

Adds the specified PdfPage to this document and maybe returns a new PdfPage object. The value returned is a new object if the added page comes from a foreign document.

◆ GetEnumerator()

new IEnumerator PdfSharp.Pdf.PdfPages.GetEnumerator ( )

Gets the enumerator.

◆ Insert() [1/2]

PdfPage PdfSharp.Pdf.PdfPages.Insert ( int index )

Creates a new PdfPage, inserts it at the specified position into this document, and returns it.

◆ Insert() [2/2]

PdfPage PdfSharp.Pdf.PdfPages.Insert	(	int	index,
		PdfPage	page
	)

Inserts the specified PdfPage at the specified position to this document and maybe returns a new PdfPage object. The value returned is a new object if the inserted page comes from a foreign document.

◆ MovePage()

void PdfSharp.Pdf.PdfPages.MovePage	(	int	oldIndex,
		int	newIndex
	)

Moves a page within the page sequence.

Parameters

oldIndex	The page index before this operation.
newIndex	The page index after this operation.

◆ Remove()

void PdfSharp.Pdf.PdfPages.Remove ( PdfPage page )

Removes the specified page from the document.

◆ RemoveAt()

void PdfSharp.Pdf.PdfPages.RemoveAt ( int index )

Removes the specified page from the document.

Property Documentation

◆ Count

int PdfSharp.Pdf.PdfPages.Count

get

Gets the number of pages.

◆ PagesArray

PdfArray PdfSharp.Pdf.PdfPages.PagesArray

get

Gets a PdfArray containing all pages of this document. The array must not be modified.

◆ this[int index]

PdfPage PdfSharp.Pdf.PdfPages.this[int index]

get

Gets the page with the specified index.

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

PdfSharp.Pdf/PdfPages.cs

Classes

Public Member Functions

Properties

Additional Inherited Members