ASPX Pages to PDF in ASP .NET

Published: 2021-09-29 04:25:55

 

---
canonical_url: https://ironpdf.com/tutorials/aspx-to-pdf/ 
---

This ASPX to PDF tutorial will guide you step-by-step how to save an ASPX page as a PDF in ASP.NET web applications. Apply settings including setting file behavior and names, adding headers & footers, changing print options, adding page breaks, combining Async & Multithreading, and more.

 

## Using ASP.NET to PDF Conversion


Microsoft Web Form Applications for ASP.Net are commonly used in the development of sophisticated websites, online banking, intranets and accounting systems. One common feature of ASP.Net (ASPX) websites is to generate dynamic PDF files such as invoices, tickets, or management reports for users to download in PDF format. 

This tutorial shows how to use the IronPDF software component for .NET to turn any ASP.Net web form into a PDF (ASP .Net to PDF). HTML, normally rendered as a web page, will be used to render as a PDF for download or viewing in a web browser. The attached source project will show you how to convert a webpage to PDF in Asp .net using C#.

We achieve this HTML to PDF conversion (ASPX to PDF) when rendering webpages using the IronPDF library and its [**AspxToPdf**](https://ironpdf.com/object-reference/api/IronPdf.AspxToPdf.html) Class.

 

##  1. Install the C# Library Free from IronPDF

 

<h3>Install via NuGet</h3>

In Visual Studio, right click on your project solution explorer and select "Manage Nuget Packages...". From there simply search for IronPDF and install the latest version... click ok to any dialog boxes that come up.

This will work in any C# .Net Framework project from Framework 4 and above, or .Net Core 2 and above.  It will also work just as well in VB.Net projects.

```
PM > Install-Package IronPdf 
```

<a class="js-modal-open" href="https://www.nuget.org/packages/IronPdf" target="_blank" data-modal-id="trial-license-after-download">https://www.nuget.org/packages/IronPdf</a>


<h3>Install via DLL</h3>

Alternatively, the IronPDF DLL can be downloaded and manually installed to the project or GAC from <a class="js-modal-open" href="https://ironpdf.com/packages/IronPdf.zip" data-modal-id="trial-license-after-download">https://ironpdf.com/packages/IronPdf.zip</a>

Remember to add this statement to the top of any **cs** class file using IronPDF:
```
  using IronPdf;
```

<hr class="separator"></hr>

<h4 class="tutorial-segment-title">How to Tutorials</h4>


## 2. Convert ASP.NET Webpages to PDF

We start with a normal ASPX "Web Form," which renders as HTML.  We later **convert the ASPX page to PDF** file format. 

In the attached example source code, we rendered a business invoice "Invoice.aspx," a simple HTML business invoice rendered as an ASP .NET Page.

The HTML page contains CSS3 stylesheets and may also include images and javascript.

To render this ASP.NET Web Page to a PDF instead of HTML, we need to open the C# (or VB.Net) code and add this to the ***Page_Load*** event:

```cs
IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.InBrowser);
```

This is all that's required; the HTML now renders as a PDF. Hyperlinks, StyleSheets, Images and even HTML forms are preserved. This is very similar to the output if the user printed the HTML to a PDF in their browser themselves. IronPDF is built upon Chromium web browser technology that powers Google Chrome.

The entire C# code reads like this in full:

```cs
/**
Render ASPX Page as PDF
anchor-convert-asp-net-webpages-to-pdf
**/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
using IronPdf;

namespace AspxToPdfTutorial
{
    public partial class Invoice : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.InBrowser);
        }
    }
}
```

<hr class="separator"></hr>

## 3. Apply ASPX File to PDF Converter Settings

There are many options to tweak and perfect when we convert an ASPX file to PDF generated using .Net Web Forms.

These options are documented in full online at https://ironpdf.com/object-reference/api/IronPdf.AspxToPdf.html

### 3.1. Set PDF File Behavior 

"**InBrowser**" file behavior attempts to show the PDF directly in the user's browser.  This is not always possible in every web browser, but typically a common feature of modern, standards-compliant browsers.

```
IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.InBrowser);
```

"**Attachment**" file behavior causes the PDF to be downloaded.

```
IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.Attachment);
```

### 3.2. Set PDF File Name 

We may also set the file name of the PDF document by adding an additional parameter. This means we can control the name of the file when the user decides to download or keep it. When we save the ASPX page as a PDF, this name will be given to the PDF document.

```
IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.Attachment, "Invoice.pdf");
```

### 3.3. Change PDF Print Options 

We can control the output of the PDF by adding an instance of the IronPdf.PdfPrintOptions Class:

https://ironpdf.com/object-reference/api/IronPdf.PdfPrintOptions.html

```cs
/**
Set Print Options
anchor-change-pdf-print-options
**/
var AspxToPdfOptions = new IronPdf.PdfPrintOptions()
    {
        DPI = 300,
        EnableJavaScript = false,
        //.. many more options available  
    };
    

IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.Attachment, "Invoice.pdf", AspxToPdfOptions);
```

 The PDF PrintOptions available include:

* **CreatePdfFormsFromHtml** Turns ASPX form elements into editable PDF forms
* **CssMediaType** Enables Media="screen" or "print" for CSS Styles and CSS3 StyleSheets
* **CustomCssUrl** Allows a custom CSS style-sheet to be applied to HTML by URL
* **DPI** Output DPI resolution of the PDF
* **EnableJavaScript** Enables JavaScript, jQuery and even Json  code within the ASPX Page.  A RenderDelay may need to be applied
* **FirstPageNumber** First page number for *Header* and *Footer*.  The default is 1
* **FitToPaperWidth** Where possible, shrinks the PDF content to a width of 1 page of virtual paper
* **Footer**  Sets the footer content for every PDF page using content strings or even HTML
* **GrayScale** Outputs a greyscale PDF in shades of grey instead of full color
* **Header**  Sets the header content for every PDF page using content strings or even HTML
* **InputEncoding** The input character encoding as a string.  [UTF-8 is Default for ASP.NET](https://ironpdf.com/docs/questions/utf-8/)
* **JpegQuality** Quality of any image within the ASPX Page which is large enough to need to be re-sampled. Values range from 0-100. 100 is highest quality, but also largest file size
* **MarginBottom** Bottom PDF Paper margin in millimeters. Set to zero for a borderless pdf
* **MarginLeft** Left PDF Paper margin in millimeters. Set to zero for a borderless pdf
* **MarginRight** Right PDF Paper margin in millimeters. Set to zero for a borderless pdf
* **MarginTop** Top PDF Paper margin in millimeters. Set to zero for a borderless pdf
* **PaperOrientation** The PDF paper orientation.  *Landscape* or *Portrait*
* **PaperSize** Set an output paper size for PDF pages using System.Drawing.Printing.PaperKind. Alternatively developers may use the SetCustomPaperSize(int width, int height) method to create custom sizes
* **PrintHtmlBackgrounds** Prints HTML image backgrounds
* **RenderDelay** Milliseconds to wait after Html is rendered before printing so that Javacsript or JSON have time to work
* **Title** PDF Document 'Title' meta-data
* **Zoom** A % Scale level allowing the developer to enlarge or shrink html content

<hr class="separator"></hr>

## 4. Add Headers & Footers to ASPX PDFs

Using IronPDF, Headers and Footers can be added to the PDF output.

The simplest way to do this is with the *SimpleHeaderFooter* class, which supports a basic layout that can easily add dynamic data such as the current time and page numbering.

### 4.1. ASPX to PDF Header & Footer Example 

```cs
/**
Add Header Footer Class
anchor-add-headers-footers-to-aspx-pdfs
**/
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace AspxToPdfTutorial
{
    public partial class Invoice : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            var AspxToPdfOptions = new IronPdf.PdfPrintOptions()
            {
                Header = new IronPdf.SimpleHeaderFooter()
                {
                    CenterText = "Invoice",
                    DrawDividerLine = false,
                    FontFamily = "Arial",
                    FontSize = 12
                },
                Footer = new IronPdf.SimpleHeaderFooter()
                {
                    LeftText = "{date} - {time}",
                    RightText = "Page {page} of {total-pages}",
                    FontFamily = "Arial",
                    FontSize = 12,
                    
                },
            };

            IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.Attachment, "Invoice.pdf", AspxToPdfOptions);
        }
    }
}


```

Alternatively we can generate HTML headers and footers using the HtmlHeaderFooter class, which also supports CSS, images, and hyperlinks.

```cs
using System;
using System.Collections.Generic;
using System.Linq;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;

namespace AspxToPdfTutorial
{
    public partial class Invoice : System.Web.UI.Page
    {
        protected void Page_Load(object sender, EventArgs e)
        {
            var AspxToPdfOptions = new IronPdf.PdfPrintOptions()
            {
                MarginTop = 50, // make sufficiant space for an HTML header
                Header = new IronPdf.HtmlHeaderFooter()
                {
                    HtmlFragment = "<div style='text-align:right'><em style='color:pink'>page {page} of {total-pages}</em></div>" 
                }
                 
            };

            IronPdf.AspxToPdf.RenderThisPageAsPdf(IronPdf.AspxToPdf.FileBehavior.Attachment, "MyDocument.pdf", AspxToPdfOptions);
        }
    }
}
```

As seen in our examples, we may "merge" dynamic text or html into Headers / Footers using placeholders:
 - {page} for the current page number of the PDF
 - {total-pages} as the total number of pages within the PDF
 - {date} for today's date in a format appropriate to the server's system environment
 - {time} for the time in hours:seconds using a 24 hour clock
 - {html-title} inserts the *title* from the head tag of the ASPX web form
 - {pdf-title} for the document file name


<hr class="separator"></hr>

## 5. Apply ASPX File to PDF Tricks: Page Breaks

Where as HTML commonly 'flows' into a long page, PDFs simulate digital paper and are broken into consistent pages. Adding the following code to your ASPX page will automatically create a page-break in the .NET generated PDF.

```html
<div style='page-break-after: always;'>&nbsp;</div>
```

<hr class="separator"></hr>

## 6. Combine Async & Multithreading for Performance 

IronPDF was built for .NET Framework 4.0, or .NET Core 2 or above. In Framework 4.5 or above projects, [ASYNC](https://ironpdf.com/docs/questions/async/) can be utilised to improve performance when working with multiple documents.  

Combining Async with multithreaded CPUs and the Paralllel.ForEach command will improve bulk processing significantly.

<hr class="separator"></hr>

## 7. Download as ASP.NET Source Code

The full **ASPX File to PDF Converter Source Code** for this tutorial is available to be downloaded as a zipped Visual Studio Web Application project.

[Download this tutorial as a ASP.Net Visual Studio project](https://ironpdf.com/downloads/Aspx-To-Pdf-Tutorial.zip)


The free download contains working code examples for a C# ASP.Net Web Forms project showing a web page rendered as a PDF with settings applied. We hope this tutorial has helped you to learn how to save an [ASPX page as PDF](https://ironpdf.com//use-case/aspx-to-pdf-converter/).

<h2>Going Forwards</h2>

Generally, the best way to learn any programming technique is through experimentation within your own ASP.NET projects. This includes trying the ASPX to PDF Converter from IronPDF.

Developers may also be interested in the IronPdf.AspxToPdf Class reference:
https://ironpdf.com/object-reference/api/IronPdf.AspxToPdf.html