PdfPageObjectCollection Class

Namespace:
GemBox.Pdf
Assembly:
GemBox.Pdf.dll

Represents a collection of page tree nodes, both intermediate and leaf that are kids of the particular intermediate page tree node.

[ComVisible(false)]
public sealed class PdfPageObjectCollection : PdfCollection<PdfPageObject>, IList, ICollection, IList<PdfPageObject>, ICollection<PdfPageObject>, IReadOnlyList<PdfPageObject>, IReadOnlyCollection<PdfPageObject>, IEnumerable<PdfPageObject>, IEnumerable
<ComVisible(False)>
    Inherits PdfCollection(Of PdfPageObject)
    Implements IList, ICollection, IList(Of PdfPageObject), ICollection(Of PdfPageObject), IReadOnlyList(Of PdfPageObject), IReadOnlyCollection(Of PdfPageObject), IEnumerable(Of PdfPageObject), IEnumerable
Inheritance:
System.Object
PdfPageObjectCollection
Implements
System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<PdfPageObject>
System.Collections.Generic.ICollection<PdfPageObject>
System.Collections.Generic.IReadOnlyList<PdfPageObject>
System.Collections.Generic.IReadOnlyCollection<PdfPageObject>
System.Collections.Generic.IEnumerable<PdfPageObject>
System.Collections.IEnumerable

Methods

AddClone(PdfPageObject)

Adds the clone of the specified PdfPageObject to the PdfPageObjectCollection.

public PdfPageObject AddClone(PdfPageObject source)
Public Function AddClone(source As PdfPageObject) As PdfPageObject
Parameters
source
PdfPageObject

The PdfPageObject whose clone should be added to the PdfPageObjectCollection.

Returns
PdfPageObject

Clone of the specified PdfPageObject added to the PdfPageObjectCollection.

Exceptions
System.ArgumentNullException

source is null.

AddPage()

Adds a new empty PdfPage to the PdfPageObjectCollection.

public PdfPage AddPage()
Public Function AddPage As PdfPage
Returns
PdfPage

AddPages()

Adds a new empty PdfPages to the PdfPageObjectCollection.

public PdfPages AddPages()
Public Function AddPages As PdfPages
Returns
PdfPages

InsertClone(Int32, PdfPageObject)

Inserts the clone of the specified PdfPageObject to the PdfPageObjectCollection at the specified index.

public PdfPageObject InsertClone(int index, PdfPageObject source)
Public Function InsertClone(index As Integer, source As PdfPageObject) As PdfPageObject
Parameters
index
System.Int32

The zero-based index at which clone of the PdfPageObject should be inserted.

source
PdfPageObject

The PdfPageObject whose clone should be inserted to the PdfPageObjectCollection.

Returns
PdfPageObject

Clone of the specified PdfPageObject inserted to the PdfPageObjectCollection.

Exceptions
System.ArgumentNullException

source is null.

InsertPage(Int32)

Adds a new empty PdfPage to the PdfPageObjectCollection at the specified index.

public PdfPage InsertPage(int index)
Public Function InsertPage(index As Integer) As PdfPage
Parameters
index
System.Int32

The zero-based index at which PdfPage should be inserted.

Returns
PdfPage

The PdfPage inserted to the PdfPageObjectCollection.

Exceptions
System.ArgumentOutOfRangeException

index is less than 0 or greater than Count.

InsertPages(Int32)

Adds a new empty PdfPages to the PdfPageObjectCollection at the specified index.

public PdfPages InsertPages(int index)
Public Function InsertPages(index As Integer) As PdfPages
Parameters
index
System.Int32

The zero-based index at which PdfPages should be inserted.

Returns
PdfPages

The PdfPages inserted to the PdfPageObjectCollection.

Exceptions
System.ArgumentOutOfRangeException

index is less than 0 or greater than Count.

Inherited Properties

Count

Gets the number of elements contained in the PdfCollection.

(Inherited from PdfCollection)

Metadata

(Optional; PDF 1.4) A metadata stream containing metadata for the component.

(Inherited from PdfObject)

Inherited Methods

Clear()

Removes all elements from the PdfCollection.

(Inherited from PdfCollection)

RemoveAt(System.Int32)

Removes the element at the specified index of the PdfCollection.

(Inherited from PdfCollection)

Implements

System.Collections.IList
System.Collections.ICollection
System.Collections.Generic.IList<T>
System.Collections.Generic.ICollection<T>
System.Collections.Generic.IReadOnlyList<T>
System.Collections.Generic.IReadOnlyCollection<T>
System.Collections.Generic.IEnumerable<T>
System.Collections.IEnumerable

Extension Methods

Examples

See Also