PdfDocument.Pages Property

Obtains to the collection of document pages.

Namespace: DevExpress.Pdf

Assembly: DevExpress.Pdf.v21.2.Core.dll

NuGet Package: DevExpress.Pdf.Core

Declaration

C#

public IList<PdfPage> Pages { get; }

VB.NET

Public ReadOnly Property Pages As IList(Of PdfPage)

Property Value

Type	Description
IList<PdfPage>	A collection of PdfPage objects.

Remarks

The Pages property obtian a list of document pages. Access a specific page by its index.

Add a New Page

Use the following API to append or insert a new page:

Method	Description
PdfDocumentProcessor.AddNewPage	Appends an empty page.
PdfDocumentProcessor.InsertNewPage	Inserts a page at a specified position (page number).

The following code adds a new page to a document:

C#

using DevExpress.Pdf;

using (PdfDocumentProcessor processor = new PdfDocumentProcessor())
{
    processor.LoadDocument("..\\..\\Document.pdf");
    processor.AddNewPage(PdfPaperSize.A4);
    processor.SaveDocument("..\\..\\Result.pdf");
}

VB.NET

Imports DevExpress.Pdf

Using processor As New PdfDocumentProcessor()
    processor.LoadDocument("..\..\Document.pdf")
    processor.AddNewPage(PdfPaperSize.A4)
    processor.SaveDocument("..\..\Result.pdf")
End Using

Copy a Page from Another Document

The Insert(Int32, T) method allows you to add an extracted page to another PDF file. When you add a page from another document, all page content, including bookmarks referring to this page, is copied to the resulting document.

The code sample below copies a page from one PDF document to another.

View Example: How toc copy a page from one document to another

Program.cs

using DevExpress.Pdf;

using (PdfDocumentProcessor source = new PdfDocumentProcessor())
{
    source.LoadDocument("..\\..\\Document1.pdf");
    using (PdfDocumentProcessor target = new PdfDocumentProcessor())
    {
        target.LoadDocument("..\\..\\Document2.pdf");
        target.Document.Pages.Insert(3, source.Document.Pages[0]);
        target.SaveDocument("..\\..\\Result.pdf");
    }
}

Program.vb

Imports DevExpress.Pdf

Using source As New PdfDocumentProcessor()
    source.LoadDocument("..\..\Document1.pdf")
    Using target As New PdfDocumentProcessor()
        target.LoadDocument("..\..\Document2.pdf")
        target.Document.Pages.Insert(3, source.Document.Pages(0))
        target.SaveDocument("..\..\Result.pdf")
    End Using
End Using

Extract a Page

Use the Add(T) method to add pages to the collection. When you add a page from another document, all page content, including bookmarks referring to this page, is copied to the resulting document.

View Example

Program.cs

using DevExpress.Pdf;

using (PdfDocumentProcessor source = new PdfDocumentProcessor())
{
    source.LoadDocument("..\\..\\Document.pdf");
    using (PdfDocumentProcessor target = new PdfDocumentProcessor())
    {
        target.CreateEmptyDocument("..\\..\\ExtractedFirstPage.pdf");
        target.Document.Pages.Add(source.Document.Pages[0]);
    }
}

Program.vb

Imports DevExpress.Pdf

Using source As New PdfDocumentProcessor()
    source.LoadDocument("..\..\Document.pdf")
    Using target As New PdfDocumentProcessor()
        target.CreateEmptyDocument("..\..\ExtractedFirstPage.pdf")
        target.Document.Pages.Add(source.Document.Pages(0))
    End Using
End Using

Delete a Page

Call the PdfDocumentProcessor.DeletePage method to remove a page from a document. The PdfDocumentProcessor.DeletePages method removes a list of pages form a document.

The code sample below deletes odd-numbered pages in a document, starting with the last odd-numbered page.

View Example: Delete Pages from PDF

C#

using DevExpress.Pdf;

using (PdfDocumentProcessor pdfDocumentProcessor = new PdfDocumentProcessor())
{
  pdfDocumentProcessor.LoadDocument("..\\..\\docs\\TextDelete.pdf");
  for (int i = pdfDocumentProcessor.Document.Pages.Count; i > 0; i--)
    if (i % 2 != 0)
    {
      pdfDocumentProcessor.DeletePage(i);
    }

  pdfDocumentProcessor.SaveDocument("..\\..\\docs\\Deleted.pdf");
}

VB.NET

Imports DevExpress.Pdf

Using pdfDocumentProcessor As New PdfDocumentProcessor()
pdfDocumentProcessor.LoadDocument("..\..\docs\TextDelete.pdf")
  For i As Integer = pdfDocumentProcessor.Document.Pages.Count To 0+1 Step -1
    If i Mod 2 <> 0 Then
        pdfDocumentProcessor.DeletePage(i)
    End If
  Next i
pdfDocumentProcessor.SaveDocument("..\..\docs\Deleted.pdf")
End Using

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the Pages property.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

pdf-document-api-extract-pages-from-document/CS/ExtractFirstPage/Program.cs#L11

    target.CreateEmptyDocument("..\\..\\ExtractedFirstPage.pdf");
    target.Document.Pages.Add(source.Document.Pages[0]);
}

pdf-document-api-rotate-pdf-pages/CS/PdfPageRotationExample/Program.cs#L10

int angle = 0;
foreach (PdfPage page in pdfDocumentProcessor.Document.Pages) {
    angle = (angle + 90) % 360;

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/CS/CreateGraphics/Program.cs#L19

static void AddGraphics(PdfDocumentProcessor processor, string text, SolidBrush textBrush) {
    IList<PdfPage> pages = processor.Document.Pages;
    for (int i = 0; i < pages.Count; i++) {

pdf-document-api-copy-pages/CS/CopyPage/Program.cs#L11

target.LoadDocument("..\\..\\Document2.pdf");
target.Document.Pages.Insert(3, source.Document.Pages[0]);
target.SaveDocument("..\\..\\Result.pdf");

VB.NET

pdf-document-api-extract-pages-from-document/VB/ExtractFirstPage/Program.vb#L12

    target.CreateEmptyDocument("..\..\ExtractedFirstPage.pdf")
    target.Document.Pages.Add(source.Document.Pages(0))
End Using

pdf-document-api-rotate-pdf-pages/VB/PdfPageRotationExample/Program.vb#L11

Dim angle As Integer = 0
For Each page As PdfPage In pdfDocumentProcessor.Document.Pages
    angle =(angle + 90) Mod 360

pdf-document-api-add-graphics-to-landscape-and-portrait-pages/VB/CreateGraphics/Program.vb#L23

Private Shared Sub AddGraphics(ByVal processor As PdfDocumentProcessor, ByVal text As String, ByVal textBrush As SolidBrush)
    Dim pages As IList(Of PdfPage) = processor.Document.Pages
    For i As Integer = 0 To pages.Count - 1

pdf-document-api-copy-pages/VB/CopyPage/Program.vb#L12

target.LoadDocument("..\..\Document2.pdf")
target.Document.Pages.Insert(3, source.Document.Pages(0))
target.SaveDocument("..\..\Result.pdf")

pdf-document-api-replace-form-field-with-image/VB/ReplaceFormFieldWithImage/Program.vb#L21

    DrawImage(graphics, rect, x, y)
    graphics.AddToPageForeground(processor.Document.Pages(0), 72, 72)
End Using