Class AspxToPdf
One-line PDF conversion for ASP.NET WebForms - transforms any ASPX page into PDF instantly. Add to Page_Load event for automatic PDF rendering instead of HTML output.
// In your ASPX.cs code-behind:
protected void Page_Load(object sender, EventArgs e) {
// Convert this page to PDF automatically:
AspxToPdf.RenderThisPageAsPdf();
// Download as attachment:
AspxToPdf.RenderThisPageAsPdf(
FileBehavior.Attachment,
"invoice.pdf");
// Custom options:
var options = new ChromePdfRenderOptions {
MarginTop = 10,
PaperSize = PdfPaperSize.A4
};
AspxToPdf.RenderThisPageAsPdf(
FileBehavior.InBrowser,
"report.pdf",
options);
}Requires IronPdf.Extensions.ASPX NuGet package
Only for .NET Framework - use MVC for .NET Core
See: https://www.nuget.org/packages/IronPdf.Extensions.ASPX/
See: https://ironpdf.com/how-to/aspx-to-pdf/
Inheritance
Namespace: IronPdf
Assembly: IronPdf.dll
Syntax
public static class AspxToPdf : Object
Working with PDF generation in IronPDF runs through AspxToPdf. It represents one-line PDF conversion for ASP.NET WebForms - transforms any ASPX page into PDF instantly.
AspxToPdf matters when an application needs to configure or invoke PDF generation from C# code. The class encapsulates the related options and behavior in a single object that is set up once and reused across render or processing calls. Typical scenarios include batch generation pipelines, templated document workflows, and integration with existing C# document services.
To use AspxToPdf, instantiate or obtain it from the relevant entry point in the IronPDF C# API. Key methods include RenderThisPageAsPdf, RenderThisPageAsPdf. Assign options or invoke methods on the instance to configure or perform the operation. The ASPX to PDF covers typical usage in C# end to end.
using IronPdf;
// Obtain AspxToPdf from the relevant entry point in the IronPDF API
void Configure(AspxToPdf instance)
{
instance.RenderThisPageAsPdf();
}For the broader workflow, see the ASPX to PDF example and the cshtml to PDF mvc core guide in the IronPDF C# documentation. For broader context, the PDF generation portion of the IronPDF C# API contains related types that work with AspxToPdf directly. AspxToPdf exposes additional members beyond those highlighted above; the reference tables on this page list the full set. In application code, treat AspxToPdf as a configured object that is constructed once and reused across operations rather than instantiated per call. Configuration is generally idempotent: assigning the same property value twice has the same effect as assigning it once. For diagnostic purposes, inspect the relevant AspxToPdf property after each operation to confirm the configured state. See the constructors, properties, and methods tables below for the complete API surface of AspxToPdf.
Methods
RenderThisPageAsPdf(AspxToPdf.FileBehavior, String, ChromePdfRenderOptions)
Instantly converts the current ASPX page to PDF during Page_Load - no HTML output. Perfect for dynamic reports, invoices, and documents generated from WebForms.
protected void Page_Load(object sender, EventArgs e) {
// Display PDF in browser:
AspxToPdf.RenderThisPageAsPdf();
// Force download with custom name:
AspxToPdf.RenderThisPageAsPdf(
FileBehavior.Attachment,
$"Invoice_{DateTime.Now:yyyyMMdd}.pdf");
// Professional formatting:
var options = new ChromePdfRenderOptions {
PaperSize = PdfPaperSize.A4,
MarginTop = 20,
MarginBottom = 20,
PrintHtmlBackgrounds = true,
Title = "Sales Report"
};
AspxToPdf.RenderThisPageAsPdf(
FileBehavior.InBrowser,
"report.pdf",
options);
}Renders after all server controls have processed
Call early in Page_Load to prevent response conflicts
See: https://ironpdf.com/examples/aspx-to-pdf/
Declaration
public static void RenderThisPageAsPdf(AspxToPdf.FileBehavior behavior, string pdfFileName = null, ChromePdfRenderOptions printOptions = null)
Parameters
| Type | Name | Description |
|---|---|---|
| AspxToPdf.FileBehavior | behavior | Specifies if the PDF file should be downloaded as an attachment, or displayed directly in the browser of users. |
| System.String | pdfFileName | The file-name of the PDF. If no name is set, a suitable name will be automatically assigned chosen based on the Html title, PrintOptions or name of the ASPX page. |
| ChromePdfRenderOptions | printOptions | Sets PDF output options such as PDF Title, paper-size, DPI, headers and footers. |
RenderThisPageAsPdf(Action<PdfDocument>, ChromePdfRenderOptions, String)
Automatically renders this ASPX page into PDF and returns that PDF document in an callback. Use it in the Page_Load Event.
Declaration
public static void RenderThisPageAsPdf(Action<PdfDocument> Callback, ChromePdfRenderOptions PrintOptions = null, string PdfFileName = null)
Parameters
| Type | Name | Description |
|---|---|---|
| System.Action<PdfDocument> | Callback | An callback method that handles the rendered PdfDocument object. |
| ChromePdfRenderOptions | PrintOptions | Sets PDF output options such as PDF Title, paper-size, DPI, headers and footers. |
| System.String | PdfFileName | Output file name |