Search Results for

    Show / Hide Table of Contents

    Class Installation

    Global installation and setup preferences for all instances of IronPDF

    Inheritance
    System.Object
    Installation
    Inherited Members
    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    Namespace: IronPdf
    Assembly: IronPdf.dll
    Syntax
    public static class Installation

    Fields

    SendAnonymousAnalyticsAndCrashData

    Opt in or out of sending anonymous usage statistics about IronPDF usage and performance to help us improve the product and developer experience.

    Usage statistics are never sent in commercially deployed projects (when a license key is applied), only during development usage.

    Declaration
    public static bool SendAnonymousAnalyticsAndCrashData
    Field Value
    Type Description
    System.Boolean

    Properties

    AutomaticallyDownloadNativeBinaries

    Set to True to let IronPDF try to download missing NativeBinaries from the internet at a runtime.

    Declaration
    public static bool AutomaticallyDownloadNativeBinaries { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Useful for IronPdf.Slim

    ChromeBrowserCachePath

    Disk cache path for chrome browser instances

    Declaration
    public static string ChromeBrowserCachePath { get; set; }
    Property Value
    Type Description
    System.String

    ChromeBrowserLimit

    Maximum number of concurrent browsers when using the Chrome renderer

    Declaration
    public static int ChromeBrowserLimit { get; set; }
    Property Value
    Type Description
    System.Int32

    ChromeGpuMode

    Chrome renderer GPU compatibility mode. In special environment like Docker or Cloud Service please use ChromeGpuModes.Disabled

    Declaration
    public static ChromeGpuModes ChromeGpuMode { get; set; }
    Property Value
    Type Description
    ChromeGpuModes

    CustomDeploymentDirectory

    Custom deployment directory for renderer native binaries.

    Declaration
    public static string CustomDeploymentDirectory { get; set; }
    Property Value
    Type Description
    System.String

    IronPdfEngineVersion

    Declaration
    public static string IronPdfEngineVersion { get; }
    Property Value
    Type Description
    System.String

    LinuxAndDockerDependenciesAutoConfig

    If true The necessary package dependencies for IronPDF rendering will we automatically installed to Docker and Debian / Ubuntu Linux deployments.

    Applies only to IronPDF for .Net Core.

    This will take a few minutes the next time you run IronPDF. Watch the Visual Studio "Output" window for progress.

    Set this to false if manual Docker / Linux setup is more convenient: https://ironpdf.com/docs/questions/docker-linux/

    Declaration
    public static bool LinuxAndDockerDependenciesAutoConfig { get; set; }
    Property Value
    Type Description
    System.Boolean
    See Also
    IronSoftware.Deployment.DeploymentEngine.SkipInstallCommands

    SkipInitialization

    Set to True to skip certain initialization routines, e.g. Cef initialization

    Declaration
    public static bool SkipInitialization { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Useful for certain environments which have persistence, e.g. IIS or web apps

    SkipShutdown

    Set to True to skip certain shutdown routines, e.g. Cef shutdown

    Declaration
    public static bool SkipShutdown { get; set; }
    Property Value
    Type Description
    System.Boolean
    Remarks

    Useful for certain environments which have persistence, e.g. IIS or web apps

    TempFolderPath

    The temporary folder path which temporary files and rendering engine DLLs will be deployed to where necessary. The default location is the system temp folder which is appropriate for most use cases.

    Declaration
    public static string TempFolderPath { get; set; }
    Property Value
    Type Description
    System.String
    Exceptions
    Type Condition
    System.ArgumentException

    value is a zero-length string, contains only white space, or contains one or more of the invalid characters defined in System.IO.Path.GetInvalidPathChars. -or- The system could not retrieve the absolute path.

    System.Security.SecurityException

    The caller does not have the required permissions.

    System.ArgumentNullException

    value is null.

    System.NotSupportedException

    value contains a colon (":") that is not part of a volume identifier (for example, "c:").

    System.IO.PathTooLongException

    The specified path, file name, or both exceed the system-defined maximum length.

    IronPdfProductException

    The property TempFolderPath is already initialized.

    Methods

    Cleanup()

    Shutdown and clean-up rendering resources used by IronPDF. Prevents further renders from completing on this process

    Declaration
    public static void Cleanup()

    CleanupTempImages(Nullable<TimeSpan>)

    Method to remove temporary images from TempFolderPath

    If you used a customTempFolderPath then set TempFolderPath to point towards your deployment directory before you call this cleanup method.

    Declaration
    public static void CleanupTempImages(TimeSpan? expirationTime = null)
    Parameters
    Type Name Description
    System.Nullable<System.TimeSpan> expirationTime

    Time from last access for files to delete. All files are deleted by default.

    Initialize()

    Initializes IronPDF rendering engines immediately to avoid startup time on your first render.

    Declaration
    public static void Initialize()

    UseIronPdfEngineDocker(Int32, String)

    Use IronPDF engine docker. PDF operations will happen on the connected IronPDF engine docker. This setting required IronPdfEngine is already up and running. Get IronPDF engine docker see official-ironpdfengine-docker for more information.

    Declaration
    public static void UseIronPdfEngineDocker(int port = 33350, string ip = "127.0.0.1")
    Parameters
    Type Name Description
    System.Int32 port

    A IronPdfEngine port

    System.String ip

    A IronPdfEngine ip

    Inherited members

    System.Object.Equals(System.Object)
    System.Object.Equals(System.Object, System.Object)
    System.Object.GetHashCode()
    System.Object.GetType()
    System.Object.MemberwiseClone()
    System.Object.ToString()
    System.Object.ReferenceEquals(System.Object, System.Object)
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Free 30-Day Trial Key
    In This Article
    Back to top
    Install with Nuget
    Want to deploy IronPDF to a live project for FREE?
    What’s included?
    30 days of fully-functional product
    Test and share in a live environment
    No watermarks in production
    Get your free 30-day Trial Key instantly.
    No credit card or account creation required
    Your Trial License Key has been emailed to you.
    Download IronPDF free to apply
    your Trial Licenses Key
    Install with NuGet View Licenses
    Licenses from $499. Have a question? Get in touch.