Search Results for

    Show / Hide Table of Contents

    Class ExceptionHelper

    Inheritance
    System.Object
    ExceptionHelper
    Namespace: IronSoftware.Exceptions
    Assembly: IronPdf.dll
    Syntax
    public static class ExceptionHelper : Object

    ExceptionHelper is what composes the message text attached to raised IronPDF exceptions, the internal string-composition utility behind the format you read when catching them. Application code that catches IronPDF exceptions reads the result of this composition through the standard Exception.Message property and rarely calls ExceptionHelper directly.

    ExceptionHelper matters when reading exception messages produced by IronPDF, because every message in the IronSoftware.Exceptions namespace family follows the same composed format: a human-readable summary, a help URL pointing into the troubleshooting catalog, an optional issue code such as IRONPDF-NATIVE-EXCEPTION, and an optional issue detail. Recognising the format makes it possible to parse a raised exception's Message for the help link and the issue code without bespoke regex, and makes log lines such as the one in the IronPDF native exception troubleshooting guide immediately searchable against the support catalog.

    The full API surface of ExceptionHelper is a single static method. ExceptionHelper.Message(string message, string helpUrl, string issueCode = null, string issueDetail = null) returns a string. The first two parameters are required; the trailing issueCode and issueDetail parameters default to null and are appended only when non-null. The method is a pure formatter, takes no state, and is thread-safe by virtue of the static signature and the lack of any shared field. Because the class is static, it has no constructors and cannot be instantiated, and every call uses ExceptionHelper.Message(...) directly.

    using IronSoftware.Exceptions;
    
    // ExceptionHelper composes the Message string that IronPDF attaches to its
    // exception types. Application code typically reads the composed string from
    // the caught exception's Message property, not by calling this method.
    string composed = ExceptionHelper.Message(
        message: "Error while generating PDF from HTML",
        helpUrl: "https://ironpdf.com/troubleshooting/ironpdf-native-exception/",
        issueCode: "IRONPDF-NATIVE-EXCEPTION");

    For the canonical raised exception type that surfaces the composed text, see the IronPDF native exception troubleshooting guide. When a raised IronPDF exception cannot be resolved from the help URL alone, the engineering support request guide lists the log files to attach.

    Methods

    Message(String, String, String, String)

    Declaration
    public static string Message(string message, string helpUrl, string issueCode = null, string issueDetail = null)
    Parameters
    Type Name Description
    System.String message
    System.String helpUrl
    System.String issueCode
    System.String issueDetail
    Returns
    Type Description
    System.String
    ☀
    ☾
    Downloads
    • Download with Nuget
    • Start for Free
    In This Article
    Back to top
    Install with Nuget
    IronPDF_for_dotnet_log2o
    Blue key in circleGet started for FREE
    No credit card required
    Test in a live environment

    Test in production without watermarks.
    Works wherever you need it to.

    Fully-functional product

    Get 30 days of fully functional product.
    Have it up and running in minutes.

    24/5 technical support

    Full access to our support engineering team during your product trial

    Grey key in circleGet started for FREE
    The trial form was submitted successfully.
    Calendar in circleBook Free Live Demo
    No contact, no card details, no commitments Book a 30-minute, personal demo.
    Here's what to expect:

    A live demo of our product and its key features

    Get project specific feature recommendations

    All your questions are answered to make sure you have all the information you need. (No commitment whatsoever.)

    Grey key in circleBook Free Live Demo
    Your booking has been completed Check your e-mail for confirmation
    Support Team Member 6 related to The C# PDF Library Support Team Member 14 related to The C# PDF Library Support Team Member 4 related to The C# PDF Library Support Team Member 2 related to The C# PDF Library
    Online 24/5
    Need help? Our sales team would be glad to help you.
    Try the Enterprise Trial
    ironpdf_for_dotnet_log2o
    Key in blue circle
    Get your free 30-day Trial Key instantly.
    bullet_checkedNo credit card or account creation required
    Key in blue circle
    Get your free 30-day Trial Key instantly.
    Blue key in circleNo credit card or account creation required
    Green Check in orange circle
    The trial form was submitted successfully.
    badge_greencheck_in_yellowcircle
    Thank you for starting a trial

    Please check your email for the trial license key.

    If you don’t receive an email, please start a live chat or email support@ironsoftware.com

    Install with NuGet
    View Licensing
    • Logo Aetna
    • Logo NASA
    • Logo GE
    • Logo Porsche
    • Logo USDA
    • Logo Qatar
    Join Millions of Engineers who’ve tried IronPDF