DeletePages Method

Summary

Delete one or more pages from the file associated with this PDFFile object.

Syntax

C++

public void DeletePages( 
   int firstPageNumber, 
   int lastPageNumber, 
   string destinationFileName 
)

Public Sub DeletePages( _ 
   ByVal firstPageNumber As Integer, _ 
   ByVal lastPageNumber As Integer, _ 
   ByVal destinationFileName As String _ 
)

public: 
void DeletePages(  
   int firstPageNumber, 
   int lastPageNumber, 
   String^ destinationFileName 
)

Parameters

firstPageNumber
The 1-based number of the first page to be deleted. Must be a value greater than or equal to 1.

lastPageNumber
The 1-based number of the last page to be deleted. Must be a value greater than or equal to firstPageNumber and less than or equal to the total number of pages in the file. Use the special value of -1 to represents "last page in the file".

destinationFileName
Name of the destination PDF file to be created. If the value of this parameter is null then the filename set in FileName will be updated.

Remarks

To use this method, associate this PDFFile object with a valid PDF file and optional password. You can achieve this by either using the PDFFile(string fileName) or PDFFile(string fileName, string password) constructors or set the filename and optional password directly into the FileName and Password properties. You do not need to call Load before using this method.

This method will use the following properties of this PDFFile object:

DocumentProperties. If the value of this property is null, then default properties will be used
SecurityOptions. If the value of this property is not null, then the destination file will be encrypted using the properties of this property. If the value of this property is null, the result file will not be encrypted
CompatibilityLevel. The version of the generated PDF file

Example

This example will delete all pages except the first one from a PDF file.

using Leadtools; 
using Leadtools.Codecs; 
using Leadtools.Controls; 
using Leadtools.Drawing; 
using Leadtools.ImageProcessing; 
using Leadtools.Pdf; 
using Leadtools.Svg; 
using Leadtools.WinForms; 
 
public void PDFFileDeletePagesExample() 
{ 
   string sourceFileName = Path.Combine(LEAD_VARS.ImagesDir, @"Leadtools.pdf"); 
   string destinationFileName = Path.Combine(LEAD_VARS.ImagesDir, @"LEAD_DeletePages.pdf"); 
 
   // Get the number of pages in the source file 
   PDFFile file = new PDFFile(sourceFileName); 
   int pageCount = file.GetPageCount(); 
   Console.WriteLine("Pages in source file : {0}", pageCount); 
 
   // If the file has more than 1 page, delete all except the first page 
   if (pageCount > 1) 
   { 
      // -1 is (up to and including last page) 
      file.DeletePages(2, -1, destinationFileName); 
   } 
} 
 
static class LEAD_VARS 
{ 
   public const string ImagesDir = @"C:\Users\Public\Documents\LEADTOOLS Images"; 
}

Imports Leadtools 
Imports Leadtools.Codecs 
Imports Leadtools.Pdf 
Imports Leadtools.WinForms 
Imports Leadtools.Svg 
Imports Leadtools.ImageProcessing 
 
Public Sub PDFFileDeletePagesExample() 
   Dim sourceFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "Leadtools.pdf") 
   Dim destinationFileName As String = Path.Combine(LEAD_VARS.ImagesDir, "LEAD_DeletePages.pdf") 
 
   ' Get the number of pages in the source file 
   Dim file As PDFFile = New PDFFile(sourceFileName) 
   Dim pageCount As Integer = file.GetPageCount() 
   Console.WriteLine("Pages in source file : {0}", pageCount) 
 
   ' If the file has more than 1 page, delete all except the first page 
   If pageCount > 1 Then 
      ' -1 is (up to and including last page) 
      file.DeletePages(2, -1, destinationFileName) 
   End If 
End Sub 
 
Public NotInheritable Class LEAD_VARS 
   Public Const ImagesDir As String = "C:\Users\Public\Documents\LEADTOOLS Images" 
End Class

Requirements

Target Platforms

Reference

PDFFile Class

PDFFile Members

Download our FREE evaluation

Help Version 20.0.2020.4.3

Leadtools.Pdf Assembly

Introduction

Getting Started

Namespaces

Leadtools.Pdf Namespace

Assemblies