Working with Document

3 Sep 202424 minutes to read

Adding the document settings

Essential PDF supports various page setting options to control the page display, through PageSettings property of PdfDocument.

You can choose the standard or custom page size when you add a page to the PDF document. This below sample illustrates how to create a PDF document with standard page size.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Set the page size.
document.PageSettings.Size = PdfPageSize.A4
'Add a page to the document
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

You can create a PDF document with custom page size in PdfPageSettings Size property by using the following code snippet.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the custom page size.
document.PageSettings.Size = new Syncfusion.Drawing.SizeF(200, 300);
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the custom page size.
document.PageSettings.Size = new SizeF(200,300);
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Set the custom page size.
document.PageSettings.Size = New SizeF(200, 300)
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

You can change page orientation from portrait to landscape, through PdfPageOrientation Enum by using the following code snippet.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Change the page orientation to landscape
document.PageSettings.Orientation = PdfPageOrientation.Landscape;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Change the page orientation to landscape
document.PageSettings.Orientation = PdfPageOrientation.Landscape;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
' Set the page size.
document.PageSettings.Size = PdfPageSize.A4
'Change the page orientation to landscape
document.PageSettings.Orientation = PdfPageOrientation.Landscape
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

NOTE

Generally, the PDF page orientation will be updated based on the custom page size. But if a custom page orientation is set using the Orientation property, then the PDF page size will be updated based on the custom orientation.

You can also change orientation by setting the rotation angle using PdfPageRotateAngle Enum. The following code snippet illustrates the same.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Change the page orientation to 90°
document.PageSettings.Rotate = PdfPageRotateAngle.RotateAngle90;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
// Set the page size.
document.PageSettings.Size = PdfPageSize.A4;
//Change the page orientation to 90 degree.
document.PageSettings.Rotate = PdfPageRotateAngle.RotateAngle90;
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Set the page size.
document.PageSettings.Size = PdfPageSize.A4
'Change the page orientation to 90 degree
document.PageSettings.Rotate = PdfPageRotateAngle.RotateAngle90
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Creating sections in a PDF

PDF sections are parts of the PDF document, which may contain one or more pages with their unique page settings. The following code snippet illustrates how to create a PdfSection in a PDF document.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a section to PDF document.
PdfSection section = document.Sections.Add();
//Add pages to the section
PdfPage page = section.Pages.Add();

//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a section to PDF document.
PdfSection section = document.Sections.Add();
//Add pages to the section.
PdfPage page = section.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Add a section to PDF document.
Dim section As PdfSection = document.Sections.Add()
'Add pages to the section
Dim page As PdfPage = section.Pages.Add()

'Create PDF graphics for the page
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Printing PDF document

To print a PDF document, the following assemblies have to be added as references to the project.

1. Syncfusion.Compression.Base.dll
2. Syncfusion.Pdf.Base.dll
3. Syncfusion.PdfViewer.Windows.dll

The following code snippet illustrates how to print a PDF document.

C# [Windows-specific]

PdfDocumentView viewer = new PdfDocumentView();
//Load the PDF document
viewer.Load("Input.pdf");

//Initialize print dialog.
PrintDialog dialog = new PrintDialog();
dialog.AllowPrintToFile = true;
dialog.AllowSomePages = true;
dialog.AllowCurrentPage = true;
dialog.Document = viewer.PrintDocument;

//Print the PDF document
dialog.Document.Print();
//Dispose the viewer
viewer.Dispose();

VB.NET [Windows-specific]

Dim viewer As New PdfDocumentView()
'Load the PDF document
viewer.Load("Input.pdf")

'Initialize print dialog.
Dim dialog As New PrintDialog()
dialog.AllowPrintToFile = True
dialog.AllowSomePages = True
dialog.AllowCurrentPage = True
dialog.Document = viewer.PrintDocument

'Print the PDF document
dialog.Document.Print()
'Dispose the viewer
viewer.Dispose()

Working with document properties

Essential PDF allows you to set, read and modify the document information of a PDF like Author, CreationDate, Subject, Title, and Producer etc. The DocumentInformation property of the PdfDocument or PdfLoadedDocument provides access to this information.

The following code snippet illustrates how to set PDF document information.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();

//Set document information.
document.DocumentInformation.Author = "Syncfusion";
document.DocumentInformation.CreationDate = DateTime.Now;
document.DocumentInformation.Creator = "Essential PDF";
document.DocumentInformation.Keywords = "PDF";
document.DocumentInformation.Subject = "Document information DEMO";
document.DocumentInformation.Title = "Essential PDF Sample";

//Add a page to the document.
PdfPage page = document.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();

//Set document information.
document.DocumentInformation.Author = "Syncfusion";
document.DocumentInformation.CreationDate = DateTime.Now;
document.DocumentInformation.Creator = "Essential PDF";
document.DocumentInformation.Keywords = "PDF";
document.DocumentInformation.Subject = "Document information DEMO";
document.DocumentInformation.Title = "Essential PDF Sample";

//Add a page to the document.
PdfPage page = document.Pages.Add();
//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()

'Set document information.
document.DocumentInformation.Author = "Syncfusion"
document.DocumentInformation.CreationDate = DateTime.Now
document.DocumentInformation.Creator = "Essential PDF"
document.DocumentInformation.Keywords = "PDF"
document.DocumentInformation.Subject = "Document information DEMO"
document.DocumentInformation.Title = "Essential PDF Sample"

'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()
'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

To read and modify the document DocumentInformation property to an existing PDF document using PDFLoadedDocument class.The following code example explain this.

C# [Cross-platform]

//Load the PDF document
FileStream docStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument document = new PdfLoadedDocument(docStream);

//Modify document information.
document.DocumentInformation.Author = "Syncfusion";
document.DocumentInformation.CreationDate = DateTime.Now;
document.DocumentInformation.Creator = "Essential PDF";
document.DocumentInformation.Keywords = "PDF";
document.DocumentInformation.Subject = "Document information DEMO";
document.DocumentInformation.Title = "Essential PDF Sample";

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfLoadedDocument document = new PdfLoadedDocument("Input.pdf");

//Modify document information.
document.DocumentInformation.Author = "Syncfusion";
document.DocumentInformation.CreationDate = DateTime.Now;
document.DocumentInformation.Creator = "Essential PDF";
document.DocumentInformation.Keywords = "PDF";
document.DocumentInformation.Subject = "Document information DEMO";
document.DocumentInformation.Title = "Essential PDF Sample";

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfLoadedDocument("Input.pdf")

'Modify document information.
document.DocumentInformation.Author = "Syncfusion"
document.DocumentInformation.CreationDate = DateTime.Now
document.DocumentInformation.Creator = "Essential PDF"
document.DocumentInformation.Keywords = "PDF"
document.DocumentInformation.Subject = "Document information DEMO"
document.DocumentInformation.Title = "Essential PDF Sample"

'Save the document
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Remove Specific Keys from the Existing Document Information

To remove specific details from the existing document information, use the Remove method of the DocumentInformation property. The following code example explains how to do this.

C# [Cross-platform]

//Load an existing PDF document. 
FileStream docStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument document = new PdfLoadedDocument(docStream); 

//Remove the document information properties. 
document.DocumentInformation.Remove("Title"); 
document.DocumentInformation.Remove("Author"); 
document.DocumentInformation.Remove("Subject"); 
document.DocumentInformation.Remove("Keywords"); 
document.DocumentInformation.Remove("Creator"); 
document.DocumentInformation.Remove("Producer"); 
document.DocumentInformation.Remove("ModDate"); 
document.DocumentInformation.Remove("CreationDate"); 

//Creating the stream object.
MemoryStream stream = new MemoryStream();
//Save the document into stream.
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Load an existing PDF document. 
PdfLoadedDocument document = new PdfLoadedDocument("Input.pdf"); 

//Remove the document information properties. 
document.DocumentInformation.Remove("Title"); 
document.DocumentInformation.Remove("Author"); 
document.DocumentInformation.Remove("Subject"); 
document.DocumentInformation.Remove("Keywords"); 
document.DocumentInformation.Remove("Creator"); 
document.DocumentInformation.Remove("Producer"); 
document.DocumentInformation.Remove("ModDate"); 
document.DocumentInformation.Remove("CreationDate"); 

//Save the document. 
document.Save("Output.pdf"); 
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Load an existing PDF document.
Dim document As PdfLoadedDocument = New PdfLoadedDocument("Input.pdf")

'Remove the document information properties. 
document.DocumentInformation.Remove("Title")
document.DocumentInformation.Remove("Author")
document.DocumentInformation.Remove("Subject")
document.DocumentInformation.Remove("Keywords")
document.DocumentInformation.Remove("Creator")
document.DocumentInformation.Remove("Producer")
document.DocumentInformation.Remove("ModDate")
document.DocumentInformation.Remove("CreationDate")

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Performing incremental update for PDF document

The Essential PDF supports incremental update for PDF document. The content of a PDF file can be updated incrementally without rewriting the entire file. Changes are appended to the end of the file, leaving its original contents intact. The main benefit is small changes to a large PDF document can be saved quickly but the resultant document size gets increased compared with the original PDF document. Disabling the IncrementalUpdate of PdfFileStructure will rewrite the entire file, which results in a smaller PDF. This is illustrated in the following code sample.

C# [Cross-platform]

//Load the PDF document
FileStream docStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument loadedDocument = new PdfLoadedDocument(docStream);

//Disable the incremental update
loadedDocument.FileStructure.IncrementalUpdate = false;
//Set the compression level
loadedDocument.Compression = PdfCompressionLevel.Best;

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
loadedDocument.Save(stream);
//Close the document.
loadedDocument.Close(true);

C# [Windows-specific]

//Load the PDF document.
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("Input.pdf");

//Disable the incremental update.
loadedDocument.FileStructure.IncrementalUpdate = false;
//Set the compression level.
loadedDocument.Compression = PdfCompressionLevel.Best;

//Save the document.
loadedDocument.Save("Output.pdf");
//Close the document.
loadedDocument.Close(true);

VB.NET [Windows-specific]

'Load the PDF document
Dim loadedDocument As New PdfLoadedDocument("Input.pdf")

'Disable the incremental update
loadedDocument.FileStructure.IncrementalUpdate = False
'Set the compression level
loadedDocument.Compression = PdfCompressionLevel.Best

'Save the document
loadedDocument.Save("Output.pdf")
'Close the document
loadedDocument.Close(True)

You can download a complete working sample from GitHub.

Choosing the viewer preferences

Essential PDF allows you to set various PDF viewer preferences to be used when the generated PDF document is displayed in a PDF reader application.

You can hide the menu bar and toolbar by enabling HideMenubar and HideToolbar properties of PdfViewerPreferences respectively. This is illustrated in the following code sample.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));
//Hide viewer application's menu bar.
document.ViewerPreferences.HideMenubar = true;
//Hide viewer application's toolbar.
document.ViewerPreferences.HideToolbar = true;
//Shows user interface elements in the document's window (such as scroll bars and navigation controls).
document.ViewerPreferences.HideWindowUI = false;

//Creating the stream object
MemoryStream stream = new MemoryStream();
//Save the document into stream
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));
//Hide viewer application's menu bar.
document.ViewerPreferences.HideMenubar = true;
//Hide viewer application's toolbar.
document.ViewerPreferences.HideToolbar = true;
//Shows user interface elements in the document's window (such as scroll bars and navigation controls).
document.ViewerPreferences.HideWindowUI = false;

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))
'Hides viewer application's menu bar.
document.ViewerPreferences.HideMenubar = True
'Hides viewer application's toolbar.
document.ViewerPreferences.HideToolbar = True
'Shows user interface elements in the document's window (such as scroll bars and navigation controls).
document.ViewerPreferences.HideWindowUI = False

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

You can also allow the reader application to initially display the bookmarks, thumbnails or attachments using PdfPageMode Enum.

C# [Cross-platform]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new Syncfusion.Drawing.PointF(0, 0));
//Show the attachments panel.
document.ViewerPreferences.PageMode = PdfPageMode.UseAttachments;

//Save the document into stream
MemoryStream stream = new MemoryStream();
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));
//Show the attachments panel.
document.ViewerPreferences.PageMode = PdfPageMode.UseAttachments;

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new PDF document.
Dim document As New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))
'Show the attachments panel.
document.ViewerPreferences.PageMode = PdfPageMode.UseAttachments

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Adding document action

Please refer to the actions section for more document level operations using the PdfJavascript and PDF actions.

Working in Multi-Threading Environment

Essential PDF allows you to create or modify PDF documents simultaneously in multi-threading environment using EnableThreadSafe property of PdfDocument class.

The following code sample illustrates how to create a PDF document in multi-threading environment.

C# [Windows-specific]

IEnumerable<int> works = Enumerable.Range(0, 100);

Parallel.ForEach(works, index => GeneratePDF(index));

private void GeneratePDF(int index)
{
//Enable the thread safe in PDF document.
PdfDocument.EnableThreadSafe = true;

//Create a new PDF document.
PdfDocument document = new PdfDocument();
//Add a page to the document.
PdfPage page = document.Pages.Add();

//Create PDF graphics for the page.
PdfGraphics graphics = page.Graphics;
//Set the standard font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));
string name = Guid.NewGuid().ToString();

//Save the document.
document.Save(name+".pdf");
//Close the document.
document.Close(true);
}

VB.NET [Windows-specific]

Dim works As IEnumerable(Of Integer) = Enumerable.Range(0, 100)
Parallel.ForEach(works, Sub(index) GeneratePDF(index))
Private Sub GeneratePDF(ByVal index As Integer)
'Enable the thread safe in PDF document.
PdfDocument.EnableThreadSafe = True

'Create a new PDF document.
Dim document As PdfDocument = New PdfDocument()
'Add a page to the document.
Dim page As PdfPage = document.Pages.Add()

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the standard font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))
Dim name As String = Guid.NewGuid().ToString()

'Save the document.
document.Save(name + ".pdf")
'Close the document.
document.Close(True)

End Sub

You can download a complete working sample from GitHub.

To modify the existing PDF document in multi-threading environment EnableThreadSafe property to an existing PDF document using PDFLoadedDocument class. The following code example explain this.

C# [Windows-specific]

IEnumerable<int> works = Enumerable.Range(0, 100);
Parallel.ForEach(works, index => GeneratePDF(index));

private void GeneratePDF(int index)
{
//Enable the thread safe in PDF document.
PdfDocument.EnableThreadSafe = true;
//Load a PDF document.
PdfLoadedDocument doc = new PdfLoadedDocument("input.pdf");
//Get first page from document
PdfLoadedPage page = doc.Pages[0] as PdfLoadedPage;

//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Set the standard font.
PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, new PointF(0, 0));
string name = Guid.NewGuid().ToString();

//Save the document.
doc.Save(name+".pdf");
//Close the document.
doc.Close(true);
}

VB.NET [Windows-specific]

Dim works As IEnumerable(Of Integer) = Enumerable.Range(0, 100)
Parallel.ForEach(works, Sub(index) GeneratePDF(index))
Private Sub GeneratePDF(ByVal index As Integer)
'Enable the thread safe in PDF document.
PdfDocument.EnableThreadSafe = True

'Load a PDF document.
Dim doc As PdfLoadedDocument = New PdfLoadedDocument("input.pdf")
'Get first page from document.
Dim page As PdfLoadedPage = doc.Pages(0)

'Create PDF graphics for the page.
Dim graphics As PdfGraphics = page.Graphics
'Set the standard font.
Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text.
graphics.DrawString("Hello World!!!", font, PdfBrushes.Black, New PointF(0, 0))
Dim name As String = Guid.NewGuid().ToString()

'Save the document.
doc.Save(name + ".pdf")
'Close the document.
doc.Close(True)

End Sub

You can download a complete working sample from GitHub.

Uniform Resource Naming in PDF document

The Essential PDF allows you to create a PDF document with proper uniform resource naming by using the EnableUniqueResourceNaming property available in the PdfDocument instance. By default, the resource naming is added uniquely. Disabling the EnableUniqueResourceNaming property will create a PDF document with uniform resource names.

The following code snippet explains how to have uniform resource naming in a PDF document.

C# [Cross-platform]

//Disable unique resource naming
PdfDocument.EnableUniqueResourceNaming = false;

//Create a new PDF document
PdfDocument doc = new PdfDocument();
//Add a page to the document
PdfPage page = doc.Pages.Add();

//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Create new instance for PDF font
PdfFont font1 = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text
graphics.DrawString("Hello World!!!", font1, PdfBrushes.Blue, new PointF(50, 50));
//Create new instance for PDF font
FileStream fontStream = new FileStream("Arial.ttf", FileMode.Open, FileAccess.Read);
PdfFont font2 = new PdfTrueTypeFont(fontStream, 20);
//Draw the text
graphics.DrawString("Hello World!!!", font2, PdfBrushes.Blue, new PointF(50, 100));
//Create new instance for PDF font
PdfFont font3 = new PdfCjkStandardFont(PdfCjkFontFamily.HeiseiMinchoW3, 20);
//Draw the text
graphics.DrawString("こんにちは世界", font3, PdfBrushes.Blue, new PointF(50, 150));

//Saving the PDF to the MemoryStream
MemoryStream stream = new MemoryStream();
doc.Save(stream);
//Close the document
doc.Close(true);

C# [Windows-specific]

//Disable unique resource naming
PdfDocument.EnableUniqueResourceNaming = false;

//Create a new PDF document
PdfDocument doc = new PdfDocument();
//Add a page to the document
PdfPage page = doc.Pages.Add();

//Create PDF graphics for the page
PdfGraphics graphics = page.Graphics;
//Create new instance for PDF font
PdfFont font1 = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
//Draw the text
graphics.DrawString("Hello World!!!", font1, PdfBrushes.Blue, new PointF(50, 50));
//Create new instance for PDF font
PdfFont font2 = new PdfTrueTypeFont(new Font("Arial", 20), true);
//Draw the text
graphics.DrawString("Hello World!!!", font2, PdfBrushes.Blue, new PointF(50, 100));
//Create new instance for PDF font
PdfFont font3 = new PdfCjkStandardFont(PdfCjkFontFamily.HeiseiMinchoW3, 20);     
//Draw the text
graphics.DrawString("こんにちは世界", font3, PdfBrushes.Blue, new PointF(50, 150));

//Save and close the document
doc.Save("Output.pdf");
doc.Close(true);

VB.NET [Windows-specific]

'Disable unique resource naming
PdfDocument.EnableUniqueResourceNaming = False

'Create a new PDF document
Dim doc As PdfDocument = New PdfDocument
'Add a page to the document
Dim page As PdfPage = doc.Pages.Add

'Create PDF graphics for the page
Dim graphics As PdfGraphics = page.Graphics
'Create new instance for PDF font
Dim font1 As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
'Draw the text
graphics.DrawString("Hello World!!!", font1, PdfBrushes.Blue, New PointF(50, 50))
'Create new instance for PDF font
Dim font2 As PdfFont = New PdfTrueTypeFont(New Font("Arial", 20), True)
'Draw the text
graphics.DrawString("Hello World!!!", font2, PdfBrushes.Blue, New PointF(50, 100))
'Create new instance for PDF font
Dim font3 As PdfFont = New PdfCjkStandardFont(PdfCjkFontFamily.HeiseiMinchoW3, 20)
'Draw the text
graphics.DrawString("こんにちは世界", font3, PdfBrushes.Blue, New PointF(50, 150))

'Save and close the document
doc.Save("Output.pdf")
doc.Close(True)

You can download a complete working sample from GitHub.

Memory Optimization

Essential PDF provides support for optimization of memory using EnableMemoryOptimization property in PdfDocument instance. Optimization will be effective only with merge, append and import functions.

Enabling this property will optimize the memory but difference in time occurs based on the document size. This is illustrated in the following code sample.

C# [Cross-platform]

//Load an existing PDF document
FileStream docStream = new FileStream("file1.pdf", FileMode.Open, FileAccess.Read);
PdfLoadedDocument loadedDocument = new PdfLoadedDocument(docStream);

//Create a new PDF document
PdfDocument document = new PdfDocument();

//Enable memory optimization
document.EnableMemoryOptimization = true;
//Append the document with source document
document.Append(loadedDocument);

//Save the document into stream
MemoryStream stream = new MemoryStream();
document.Save(stream);
//Close the documents
document.Close(true);
loadedDocument.Close(true);

C# [Windows-specific]

//Load an existing PDF document
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("file1.pdf");

//Create a new PDF document
PdfDocument document = new PdfDocument();

//Enable memory optimization
document.EnableMemoryOptimization = true;
//Append the document with source document
document.Append(loadedDocument);

//Save the PDF document
document.Save("Output.pdf");
//Close the documents
document.Close(true);
loadedDocument.Close(true);

VB.NET [Windows-specific]

'Load an existing PDF document
Dim loadedDocument As New PdfLoadedDocument("file1.pdf")

'Create a new PDF document
Dim document As New PdfDocument()

'Enable memory optimization
document.EnableMemoryOptimization = True
'Append the document with source document
document.Append(loadedDocument)

'Save the PDF document
document.Save("Output.pdf")
'Close the documents
document.Close(True)
loadedDocument.Close(True)

You can download a complete working sample from GitHub.

Find corrupted PDF document

Syncfusion PDF Library provides support to check whether the existing PDF document is corrupted or not with corruption details using PdfDocumentAnalyzer class. The following code snippet explains how to find the corrupted PDF document.

C# [Cross-platform]

//Load the PDF document 
FileStream  docStream = new  FileStream("Input.pdf", FileMode.Open, FileAccess.Read); 
//Create a new instance for the PDF analyzer
PdfDocumentAnalyzer analyzer = new PdfDocumentAnalyzer(docStream);

//Get the syntax errors
SyntaxAnalyzerResult result = analyzer.AnalyzeSyntax();
//Check whether the document is corrupted or not
if (result.IsCorrupted)
{
    //Get syntax error details from results.error
    StringBuilder builder = new StringBuilder();
    builder.AppendLine("The PDF document is corrupted.");
    int count = 1;
    foreach (PdfException exception in result.Errors)
    {
       builder.AppendLine(count++.ToString() + ": " + exception.Message);
    }              
}
else               
{
    //No syntax error found in the provided PDF document
}                    
analyzer.Close();

C# [Windows-specific]

//Create a new instance for the PDF analyzer
PdfDocumentAnalyzer analyzer = new PdfDocumentAnalyzer("Input.pdf");

//Get the syntax errors
SyntaxAnalyzerResult result = analyzer.AnalyzeSyntax();
//Check whether the document is corrupted or not
if (result.IsCorrupted)
{
   //Get syntax error details from results.error
   StringBuilder builder = new StringBuilder();
   builder.AppendLine("The PDF document is corrupted.");
   int count = 1;
   foreach (PdfException exception in result.Errors)
   {
     builder.AppendLine(count++.ToString() + ": " + exception.Message);
   }
}
else               
{
   //No syntax error found in the provided PDF document
}             
analyzer.Close();

VB.NET [Windows-specific]

'Create a new instance for the PDF analyzer
Dim analyzer As PdfDocumentAnalyzer = New PdfDocumentAnalyzer("Input.pdf")

'Get the syntax errors
Dim result As SyntaxAnalyzerResult = analyzer.AnalyzeSyntax

'Check whether the document is corrupted or not
If result.IsCorrupted Then
   'Get syntax error details from results.error
    builder = New StringBuilder
    builder.AppendLine("The PDF document is corrupted.")
    Dim count = 1
    For Each exception As PdfException In result.Errors
         builder.AppendLine(Math.Min(Threading.Interlocked.Increment(count), count - 1).ToString & ": " & exception.Message)
    Next

Else
   'No syntax error found in the provided PDF document.
End If
analyzer.Close()

You can download a complete working sample from GitHub.

Embed all the non-embedded fonts in the existing PDF document

You can embed all the non-embedded fonts in the existing PDF document using the EmbedFonts method.
Refer to the following code sample to achieve the same,

C# [Windows-specific]

//Load an existing document.
PdfLoadedDocument loadedDocument = new PdfLoadedDocument("input.pdf");
//Embed all the non-embedded fonts.
if (loadedDocument.IsAllFontsEmbedded == false)
{.
     loadedDocument.EmbedFonts();
}
//Save the document.
loadedDocument.Save("Output.pdf");
//Close the document.
loadedDocument.Close(true);

VB.NET [Windows-specific]

//Load an existing document.
Dim loadedDocument As PdfLoadedDocument = New PdfLoadedDocument("input.pdf")
// Embed all the non-embedded fonts.
If loadedDocument.IsAllFontsEmbedded = False Then
    loadedDocument.EmbedFonts()
End If
//Save the document.
loadedDocument.Save("Output.pdf")
//Close the document.
loadedDocument.Close(True)

You can download a complete working sample from GitHub.

Add or retrieve BaseUri in a PDF document

The Essential PDF allows you to get or set the BaseUri in the PDF document. This is illustrated in the following code sample.

C# [Cross-platform]

//Create a new instance of the PdfDocument class.
PdfDocument document = new PdfDocument();
//Set the Base URI.
document.BaseUri = "https://www.syncfusion.com/";
//Create a new page.
PdfPage page = document.Pages.Add();

//Save the document.
MemoryStream stream = new MemoryStream();
document.Save(stream);
//Close the document.
document.Close(true);

C# [Windows-specific]

//Create a new instance of the PdfDocument class.
PdfDocument document = new PdfDocument();
//Set the Base URI.
document.BaseUri = "https://www.syncfusion.com/";
//Create a new page.
PdfPage page = document.Pages.Add();

//Save the document.
document.Save("Output.pdf");
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Create a new instance of the PdfDocument class.
Dim document As PdfDocument = New PdfDocument()
'Set the Base URI.
document.BaseUri = "https://www.syncfusion.com/"
'Create a new page.
Dim page As PdfPage = document.Pages.Add()

'Save the document.
document.Save("Output.pdf")
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

The following code example illustrates the retrieval of BaseUri from the loaded document.

C# [Cross-platform]

//Load the PDF document as file stream.
FileStream docStream = new FileStream("Input.pdf", FileMode.Open, FileAccess.Read);
//Load a PDF document.
PdfLoadedDocument document = new PdfLoadedDocument(docStream);
//Get the Base URI.
string baseUri = document.BaseUri;
//Close the document.
document.Close(true);

C# [Windows-specific]

//Load an existing document.
PdfLoadedDocument document = new PdfLoadedDocument("Input.pdf");

//Get the Base URI.
string baseUri = document.BaseUri;
//Close the document.
document.Close(true);

VB.NET [Windows-specific]

'Load an existing document.
Dim document As PdfLoadedDocument = New PdfLoadedDocument("Input.pdf")
'Get the Base URI.
Dim baseUri As String = document.BaseUri
'Close the document.
document.Close(True)

You can download a complete working sample from GitHub.

Tracking save progress

Essential PDF enables you to track the save progress through the SaveProgress event available in the PdfDocumentBase instance.

C# [Cross-platform]

// Create a new PDF document.
      PdfDocument document = new PdfDocument();

      // Add multiple pages to the document.
      for (int i = 0; i < 10; i++)
      {
         // Add a new page.
         PdfPage page = document.Pages.Add();

         // Create PDF graphics for the page.
         PdfGraphics graphics = page.Graphics;

         // Set the font to Helvetica with size 20.
         PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);

         // Draw text on the page.
         graphics.DrawString($"This is page {i + 1}", font, PdfBrushes.Black, new PointF(0, 0));
      }

      // Subscribe to the SaveProgress event.
      document.SaveProgress += new PdfDocument.ProgressEventHandler(document_SaveProgress);

      // Create a file stream to save the PDF document.
      using (FileStream outputFileStream = new FileStream(Path.GetFullPath(@"Output/Output.pdf"), FileMode.Create, FileAccess.ReadWrite))
      {
         // Save the PDF document to the file stream.
         document.Save(outputFileStream);
      }

      // Close the document.
      document.Close(true);

      // Event handler for the SaveProgress event.
      void document_SaveProgress(object sender, ProgressEventArgs arguments)
      {
         // Output the current progress of the save operation.
         Console.WriteLine(String.Format("Current: {0}, Progress: {1}, Total: {2}", arguments.Current, arguments.Progress, arguments.Total));
      }

C# [Windows-specific]

// Create a new PDF document.
      PdfDocument document = new PdfDocument();
      // Add multiple pages to the document.
      for (int i = 0; i < 10; i++)
      {
         // Add a new page.
         PdfPage page = document.Pages.Add();
         // Create PDF graphics for the page.
         PdfGraphics graphics = page.Graphics;
         // Set the font to Helvetica with size 20.
         PdfFont font = new PdfStandardFont(PdfFontFamily.Helvetica, 20);
         // Draw text on the page.
         graphics.DrawString($"This is page {i + 1}", font, PdfBrushes.Black, new PointF(0, 0));
      }
      // Subscribe to the SaveProgress event.
      document.SaveProgress += new PdfDocument.ProgressEventHandler(document_SaveProgress);
      // Create a file stream to save the PDF document.
      using (FileStream outputFileStream = new FileStream(Path.GetFullPath(@"../../../Output/Output.pdf"), FileMode.Create, FileAccess.ReadWrite))
      {
         // Save the PDF document to the file stream.
         document.Save(outputFileStream);
      }
      // Close the document.
      document.Close(true);

      // Event handler for the SaveProgress event.
      void document_SaveProgress(object sender, ProgressEventArgs arguments)
      {
         // Output the current progress of the save operation.
         Console.WriteLine(String.Format("Current: {0}, Progress: {1}, Total: {2}", arguments.Current, arguments.Progress, arguments.Total));
      }

VB.NET [Windows-specific]

Module Program
         Sub Main()
            ' Create a new PDF document.
            Dim document As New PdfDocument()
            ' Add multiple pages to the document.
            For i As Integer = 0 To 9
                  ' Add a new page.
                  Dim page As PdfPage = document.Pages.Add()
                  ' Create PDF graphics for the page.
                  Dim graphics As PdfGraphics = page.Graphics
                  ' Set the font to Helvetica with size 20.
                  Dim font As PdfFont = New PdfStandardFont(PdfFontFamily.Helvetica, 20)
                  ' Draw text on the page.
                  graphics.DrawString(String.Format("This is page {0}", i + 1), font, PdfBrushes.Black, New PointF(0, 0))
            Next
            ' Subscribe to the SaveProgress event.
            AddHandler document.SaveProgress, AddressOf document_SaveProgress
            ' Create a file stream to save the PDF document.
            Using outputFileStream As New FileStream(Path.GetFullPath("../../../Output/Output.pdf"), FileMode.Create, FileAccess.ReadWrite)
                  ' Save the PDF document to the file stream.
                  document.Save(outputFileStream)
            End Using
            ' Close the document.
            document.Close(True)
         End Sub

         ' Event handler for the SaveProgress event.
         Private Sub document_SaveProgress(ByVal sender As Object, ByVal arguments As ProgressEventArgs)
            ' Output the current progress of the save operation.
            Console.WriteLine(String.Format("Current: {0}, Progress: {1}, Total: {2}", arguments.Current, arguments.Progress, arguments.Total))
         End Sub
      End Module

You can download a complete working sample from GitHub.