Class BaseHttpLoginCredentials
Provides a base class for all of IronPdf's embedded browser HTML renderers to also log-in to an intranet, extranet or website, impersonating a user. This allows a unique ability to render web-pages as PDFs even on secure intranets, extranets and websites.
Inheritance
Implements
Namespace: IronPdf.Rendering.Abstractions
Assembly: IronPdf.dll
Syntax
public class BaseHttpLoginCredentials : Object, IHttpLoginCredentials
Constructors
BaseHttpLoginCredentials()
Declaration
public BaseHttpLoginCredentials()
Fields
CustomCookies
A Dictionary which allows custom cookies to be posted with every login request, and HTTP request made by RenderUriToHml methods.
Declaration
public Dictionary<string, string> CustomCookies
Field Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
CustomHttpHeaders
A dictionary of custom HTTP headers to be sent with every HTTP Request
Declaration
public Dictionary<string, string> CustomHttpHeaders
Field Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
CustomPostFiles
Optional, Advanced Usage: Specifies a collection files to summited on every PDF rendering request. Allows images and documents to be submitted to forms such that the output will be rendered as an PDF.
Note: The Key is the name of the post field, The value is the full file path.. UrlEncoding is not required.
Declaration
public Dictionary<string, string> CustomPostFiles
Field Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
CustomPostVariables
Optional: Specifies a collection of HTTP 'POST' variables to submit on every PDF rendering request.
Note: The 'key' is the name of the post field, The 'value' is its value. UrlEncoding is not required.
Declaration
public Dictionary<string, string> CustomPostVariables
Field Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
EnableCookies
Enables cookies to be stored and sent when using RenderUriToHml methods.
Declaration
public bool EnableCookies
Field Value
| Type | Description |
|---|---|
| System.Boolean |
LoginFormPostVariables
Optional: Specifies a collection of HTTP form variables to post/submit to LoginFormUrl.
Declaration
public Dictionary<string, string> LoginFormPostVariables
Field Value
| Type | Description |
|---|---|
| System.Collections.Generic.Dictionary<System.String, System.String> |
Properties
LoginFormUrl
Optional: Gives the URL to post website login-form authentication. Should be the absolute Url which the form's action attribute specifies.
Declaration
public Uri LoginFormUrl { get; set; }
Property Value
| Type | Description |
|---|---|
| System.Uri |
NetworkPassword
Optional: Password credential for Windows / Linux network security authentication.
Declaration
public string NetworkPassword { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
NetworkUsername
Optional: User-name credential for Windows / Linux network security authentication.
Declaration
public string NetworkUsername { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
Proxy
Specifies an Http proxy server. Use the pattern: http(s)://user-name:password@host:port/
Declaration
public string Proxy { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |
UserAgent
The Http User-Agent header which will be used to fetch any remote HTML.
Declaration
public string UserAgent { get; set; }
Property Value
| Type | Description |
|---|---|
| System.String |