How to use Cookies with IronPDF in C#

Curtis Chau

Updated: August 2, 2026

Download IronPDF

• NuGet Download
• DLL Download
• Windows Installer

• ---

• Start Free Trial

Copy for LLMs

• Copy for LLMs

  Copy page as Markdown for LLMs

• ---

• Open in ChatGPT

  Ask ChatGPT about this page
• Open in Gemini

  Ask Gemini about this page
• Open in Grok

  Ask Grok about this page
• Open in Perplexity

  Ask Perplexity about this page

Share

• Share on Facebook
• Share on X (Twitter)
• Share on LinkedIn

• ---

• Email article

IronPDF uses the RequestContext property and ApplyCookies method to integrate cookies into PDF rendering, maintaining session information and user authentication during HTML-to-PDF conversions.

Cookies are small data pieces that websites store on user devices. They manage sessions, track user behavior, and store preferences. Privacy regulations like GDPR and CCPA have increased focus on cookie management, prompting browsers to offer users greater control over cookie handling.

When using IronPDF's Chrome rendering engine, cookies maintain state during the HTML to PDF conversion process. This is essential when rendering pages that require TLS website authentication and system logins or user-specific preferences.

Integrate cookies into your PDF rendering process with IronPDF. This guide demonstrates using the IronPdf API to manage cookies during HTML-to-PDF conversions. Apply standard or custom cookies using the RequestContext property and ApplyCookies method with minimal code.

How Do I Apply Cookies to PDF Rendering?

What Is the RequestContext Property?

Set the RequestContext property to RequestContexts.Global before applying cookies. Create the ChromeHttpLoginCredentials class and pass it to the ApplyCookies method. The renderer then renders HTML content to PDF with cookies.

The RequestContext property works with HTTP request headers and authentication. It determines cookie sharing between rendering sessions, critical for applications maintaining session state across multiple PDF generations.

How Do I Use the ApplyCookies Method?

Apply cookies using IronPDF:

using IronPdf;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global;

ChromeHttpLoginCredentials credentials = new ChromeHttpLoginCredentials() {
    NetworkUsername = "testUser",
    NetworkPassword = "testPassword"
};

string uri = "http://localhost:51169/Invoice";

// Apply cookies
renderer.ApplyCookies(uri, credentials);

using IronPdf;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global;

ChromeHttpLoginCredentials credentials = new ChromeHttpLoginCredentials() {
    NetworkUsername = "testUser",
    NetworkPassword = "testPassword"
};

string uri = "http://localhost:51169/Invoice";

// Apply cookies
renderer.ApplyCookies(uri, credentials);

Imports IronPdf

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global

Dim credentials As New ChromeHttpLoginCredentials() With {
	.NetworkUsername = "testUser",
	.NetworkPassword = "testPassword"
}

Dim uri As String = "http://localhost:51169/Invoice"

' Apply cookies
renderer.ApplyCookies(uri, credentials)

Imports IronPdf

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

renderer.RenderingOptions.RequestContext = IronPdf.Rendering.RequestContexts.Global

Dim credentials As New ChromeHttpLoginCredentials() With {
	.NetworkUsername = "testUser",
	.NetworkPassword = "testPassword"
}

Dim uri As String = "http://localhost:51169/Invoice"

' Apply cookies
renderer.ApplyCookies(uri, credentials)

This approach works when converting ASPX pages to PDF requiring authentication or with ASP.NET MVC applications.

Which RequestContext Should I Choose?

RequestContexts Enum defines browser request contexts establishing relationships between renders. It manages cookies and user preferences.

• Isolated: Creates new, isolated request contexts. Prevents current renders from being affected by previous renders. Ideal for multi-threaded PDF generation.
• Global: Uses shared global request context between all renders. Persists browser states between renders. Perfect for maintaining session data across PDF operations.
• Auto: Defaults to IronPdf.Rendering.RequestContexts.Isolated. Switches to IronPdf.Rendering.RequestContexts.Global if IronPdf.ChromePdfRenderer.ApplyCookies(System.String, IronPdf.ChromeHttpLoginCredentials) was invoked.

When implementing cookies in Blazor Server applications, choose the appropriate RequestContext to maintain proper session state between server-side renders.

My favorite library of this kind is IronPDF. It allows for fast and efficient manipulation of PDF files. It also has many valuable features, like exporting to PDF/A format and digitally signing PDF documents.

Milan Jovanovic

Microsoft MVP

View case study

IronOCR means we can save $40,000 annually from manual processing, while enhancing productivity and freeing up resources for high-impact tasks. I would highly recommend it.

Brent Matzelle

Chief Technology Officer, OPYN

View case study

The IronSuite play a crucial role in our operations. These are tools that increase efficiencies across the business including creating floor plans and improving inventory management.

David Jones

Lead Software Engineer, Agorus Build

View case study

How Do I Apply Custom Cookies?

What Are Custom Cookies in IronPDF?

CustomCookies require setting the CustomCookies property. This property accepts string key-value pair dictionaries. Custom cookies handle complex authentication systems or pass application-level data during rendering.

Custom cookies differ from standard HTTP cookies by allowing any key-value pair definition. This flexibility suits modern web applications using JWT tokens, session IDs, or custom authentication mechanisms.

How Do I Implement Custom Cookies?

Apply custom cookies using IronPDF:

using IronPdf;
using System;
using System.Collections.Generic;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

Dictionary<string, string> customCookies = new Dictionary<string, string>();

// Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies;

var uri = new Uri("https://localhost:44362/invoice");
PdfDocument pdf = renderer.RenderUrlAsPdf(uri);

using IronPdf;
using System;
using System.Collections.Generic;

// Instantiate ChromePdfRenderer
ChromePdfRenderer renderer = new ChromePdfRenderer();

Dictionary<string, string> customCookies = new Dictionary<string, string>();

// Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies;

var uri = new Uri("https://localhost:44362/invoice");
PdfDocument pdf = renderer.RenderUrlAsPdf(uri);

Imports IronPdf
Imports System
Imports System.Collections.Generic

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

Private customCookies As New Dictionary(Of String, String)()

' Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies

Dim uri As New Uri("https://localhost:44362/invoice")
Dim pdf As PdfDocument = renderer.RenderUrlAsPdf(uri)

Imports IronPdf
Imports System
Imports System.Collections.Generic

' Instantiate ChromePdfRenderer
Private renderer As New ChromePdfRenderer()

Private customCookies As New Dictionary(Of String, String)()

' Apply custom cookies
renderer.RenderingOptions.CustomCookies = customCookies

Dim uri As New Uri("https://localhost:44362/invoice")
Dim pdf As PdfDocument = renderer.RenderUrlAsPdf(uri)

This approach suits JavaScript-heavy sites relying on cookies for state management or implementing custom logging solutions.

When Should I Use Custom Cookies vs Standard Cookies?

Custom cookies handle specific session data or authentication tokens not managed by standard HTTP credentials. Use them with custom authentication systems or to maintain user preferences during PDF generation.

Standard cookies (via ApplyCookies method) suit:

• Basic HTTP authentication
• Windows authentication environments
• Simple session management

Custom cookies excel for:

• JWT token-based authentication
• Complex session management with multiple parameters
• Third-party authentication providers (OAuth, SAML)
• User preferences and settings maintenance
• Analytics and tracking requirements

What Are Common Issues with Cookie Implementation?

Common issues include cookies not persisting between renders using Isolated context, authentication failures from incorrect cookie values, and timing issues where cookies expire before PDF generation. Verify cookie validity and consider Global context for persistent sessions.

Troubleshooting tips:

1. Cookie Expiration: Verify cookies haven't expired. Implement refresh logic for short-lived tokens.
2. Domain Restrictions: Ensure cookie domains match the rendered URL.
3. Secure Cookies: Configure secure cookies properly when rendering HTTPS URLs.
4. SameSite Policies: Consider browser SameSite cookie policies affecting cross-origin requests.

For advanced authentication and cookie scenarios, see the rendering options documentation covering all available PDF generation customization settings.

Curtis Chau

Chat with engineering team now

Technical Writer

Curtis Chau holds a Bachelor’s degree in Computer Science (Carleton University) and specializes in front-end development with expertise in Node.js, TypeScript, JavaScript, and React. Passionate about crafting intuitive and aesthetically pleasing user interfaces, Curtis enjoys working with modern frameworks and creating well-structured, visually appealing manuals.

...

Read More