Click or drag to resize

PdfPages Class

Represents an intermediate node in a page tree, called a page tree node.

Note  Note
This class provides a flattened view of all descendant PdfPages by implementing the IListT interface.
Inheritance Hierarchy
SystemObject
  SautinSoft.PdfPdfObject
    SautinSoft.PdfPdfPageObject
      SautinSoft.PdfPdfPages

Namespace: SautinSoft.Pdf
Assembly: SautinSoft.Pdf (in SautinSoft.Pdf.dll) Version: 2024.6.18
Syntax
public sealed class PdfPages : PdfPageObject, 
	IList<PdfPage>, ICollection<PdfPage>, IEnumerable<PdfPage>, 
	IEnumerable

The PdfPages type exposes the following members.

Properties
 NameDescription
Public propertyCount(Required) The number of leaf nodes (page objects) that are descendants of this node within the page tree.
Public propertyCropBox

(Optional; inheritable) A rectangle, expressed in default user space units, that shall define the visible region of default user space.

When the page is displayed or printed, its contents shall be clipped (cropped) to this rectangle and then shall be imposed on the output medium in some implementation-defined manner (see 14.11.2, "Page Boundaries").

Default value: the value of MediaBox.

Value of this property might be if this is an instance of a PdfPages, but it should never be if this is an instance of a PdfPage.


(Inherited from PdfPageObject)
Public propertyItem Gets or sets the PdfPage at the specified index.
Public propertyKids(Required) An array of indirect references to the immediate children of this node. The children shall only be page objects or other page tree nodes.
Public propertyMediaBox

(Required; inheritable) A rectangle (see 7.9.5, "Rectangles"), expressed in default user space units, that shall define the boundaries of the physical medium on which the page shall be displayed or printed (see 14.11.2, "Page Boundaries").

Value of this property might be if this is an instance of a PdfPages, but it should never be if this is an instance of a PdfPage.


(Inherited from PdfPageObject)
Public propertyMetadata(Optional; PDF 1.4) A metadata stream containing metadata for the component.
(Inherited from PdfObject)
Public propertyParent(Required except in root node; prohibited in the root node; shall be an indirect reference) The page tree node that is the immediate parent of this one.
(Inherited from PdfPageObject)
Public propertyRotate

(Optional; inheritable) The number of degrees by which the page shall be rotated clockwise when displayed or printed.

The value shall be a multiple of 90.

Default value: 0.


(Inherited from PdfPageObject)
Top
Methods
 NameDescription
Public methodAdd Adds a new empty PdfPage to the PdfPages.
Public methodAddClone Adds the clone of the specified PdfPage to the PdfPages.
Public methodClear Removes all PdfPages from the PdfCollection.
Public methodContains Determines whether a PdfPage is in the collection.
Public methodCopyTo Copies the entire collection to a compatible one-dimensional array, starting at the specified index of the target array.
Public methodEqualsDetermines whether the specified object is equal to the current object.
(Inherited from Object)
Public methodGetEnumerator Returns an enumerator that iterates through the collection of PdfPages.
Public methodGetHashCodeServes as the default hash function.
(Inherited from Object)
Public methodGetTypeGets the Type of the current instance.
(Inherited from Object)
Public methodIndexOf Searches for the specified PdfPage and returns the zero-based index of the first occurrence within the entire collection.
Public methodInsert Adds a new empty PdfPage to the PdfPages at the specified index.
Public methodInsertClone Inserts the clone of the specified PdfPage to the PdfPages at the specified index.
Public methodMove Moves the PdfPage at the specified index to a new location in the collection.
Public methodRemove Removes the first occurrence of a specific PdfPage from the collection.
Public methodRemoveAt Removes the PdfPage at the specified index of the collection.
Public methodSetCropBox(Double, Double) Sets the CropBox.
(Inherited from PdfPageObject)
Public methodSetCropBox(Double, Double, Double, Double) Sets the CropBox.
(Inherited from PdfPageObject)
Public methodSetMediaBox(Double, Double) Sets the MediaBox.
(Inherited from PdfPageObject)
Public methodSetMediaBox(Double, Double, Double, Double) Sets the MediaBox.
(Inherited from PdfPageObject)
Public methodToStringReturns a string that represents the current object.
(Inherited from Object)
Top
Extension Methods
 NameDescription
Public Extension MethodGetArray Gets the PdfArray that serves as a backing storage of the specified PdfObject or if no PdfArray serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Public Extension MethodGetOrAddDictionary Gets the PdfDictionary that serves as a backing storage of the specified PdfObject.
(Defined by PdfObjectExtensions)
Top
See Also