PDF to HTML / .NET Reference

Availability: API client version >= 5.4.0

class PdfToHtmlClient

All setter methods return PdfToHtmlClient object unless specified otherwise.

Constructor

public PdfToHtmlClient(string userName, string apiKey)

Constructor for the PDFCrowd API client.

Parameters:
  • userName - Your username at PDFCrowd.
  • apiKey - Your API key.

Conversion Input

public byte[] convertUrl(string url)

Convert a PDF.

Parameter:
  • url - The address of the PDF to convert.
    Constraint:
    • Supported protocols are http:// and https://.
Returns:
byte[] - Byte array containing the conversion output.

public void convertUrlToStream(string url, Stream outStream)

Convert a PDF and write the result to an output stream.

Parameters:
  • url - The address of the PDF to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

public void convertUrlToFile(string url, string filePath)

Convert a PDF and write the result to a local file.

Parameters:
  • url - The address of the PDF to convert.
    Constraint:
    • Supported protocols are http:// and https://.
  • filePath - The output file path.
    Constraint:
    • The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.

public byte[] convertFile(string file)

Convert a local file.

Parameter:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
Returns:
byte[] - Byte array containing the conversion output.

public void convertFileToStream(string file, Stream outStream)

Convert a local file and write the result to an output stream.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

public void convertFileToFile(string file, string filePath)

Convert a local file and write the result to a local file.

Parameters:
  • file - The path to a local file to convert.
    Constraint:
    • The file must exist and not be empty.
  • filePath - The output file path.
    Constraint:
    • The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.

public byte[] convertRawData(byte[] data)

Convert raw data.

Parameter:
  • data (byte[]) - The raw content to be converted.
Returns:
byte[] - Byte array with the output.

public void convertRawDataToStream(byte[] data, Stream outStream)

Convert raw data and write the result to an output stream.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

public void convertRawDataToFile(byte[] data, string filePath)

Convert raw data to a file.

Parameters:
  • data (byte[]) - The raw content to be converted.
  • filePath - The output file path.
    Constraint:
    • The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.

public byte[] convertStream(Stream inStream)

Convert the contents of an input stream.

Parameter:
  • inStream (InputStream) - The input stream with source data.
Returns:
byte[] - Byte array containing the conversion output.

public void convertStreamToStream(Stream inStream, Stream outStream)

Convert the contents of an input stream and write the result to an output stream.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • outStream (OutputStream) - The output stream that will contain the conversion output.

public void convertStreamToFile(Stream inStream, string filePath)

Convert the contents of an input stream and write the result to a local file.

Parameters:
  • inStream (InputStream) - The input stream with source data.
  • filePath - The output file path.
    Constraint:
    • The converter generates an HTML or ZIP file. If ZIP file is generated, the file path must have a ZIP or zip extension.

General Options

public PdfToHtmlClient setPdfPassword(string password)

Password to open the encrypted PDF file.

Parameter:
  • password - The input PDF password.

public PdfToHtmlClient setScaleFactor(int factor)

Set the scaling factor (zoom) for the main page area.

Parameter:
  • factor (int) - The percentage value.
    Constraint:
    • Must be a positive integer.
    Default:
    100

public PdfToHtmlClient setPrintPageRange(string pages)

Set the page range to print.

Parameter:
  • pages
    Constraint:
    • A comma separated list of page numbers or ranges.
Examples:
  • Just the second page is printed: setPrintPageRange("2")
  • The first and the third page are printed: setPrintPageRange("1,3")
  • Everything except the first page is printed: setPrintPageRange("2-")
  • Just first 3 pages are printed: setPrintPageRange("-3")
  • Pages 3, 6, 7, 8 and 9 are printed: setPrintPageRange("3,6-9")

public PdfToHtmlClient setDpi(int dpi)

Set the output graphics DPI.

Availability:
API client >= 5.16.0, converter >= 20.10. See versioning.
Parameter:
  • dpi (int) - The DPI value.
    Default:
    144

public PdfToHtmlClient setImageMode(string mode)

Specifies where the images are stored.

Parameter:
  • mode - The image storage mode.
    Allowed Values:
    • embed — The images are embedded into the output HTML file.
    • separate — The images are saved to separate files. In this mode the output of the conversion is a zip file containing the HTML and all image files.
    • none — The images are ignored and not converted.
    Default:
    embed

public PdfToHtmlClient setImageFormat(string imageFormat)

Specifies the format for the output images.

Availability:
API client >= 5.17.0, converter >= 20.10. See versioning.
Parameter:
  • imageFormat - The image format.
    Allowed Values:
    • png
    • jpg
    • svg
    Default:
    png

public PdfToHtmlClient setCssMode(string mode)

Specifies where the style sheets are stored.

Parameter:
  • mode - The style sheet storage mode.
    Allowed Values:
    • embed — Style sheets are embedded into the output HTML file.
    • separate — Style sheets are saved to separate files. In this mode the output of the conversion is a zip file containing the HTML and all style sheets.
    Default:
    embed

public PdfToHtmlClient setFontMode(string mode)

Specifies where the fonts are stored.

Parameter:
  • mode - The font storage mode.
    Allowed Values:
    • embed — The fonts are embedded into the output HTML file.
    • separate — The font are saved to separate files. In this mode the output of the conversion is a zip file containing HTML and all font files.
    Default:
    embed

public PdfToHtmlClient setType3Mode(string mode)

Sets the processing mode for handling Type 3 fonts.

Availability:
API client >= 6.2.0, converter >= 24.04. See versioning.
Parameter:
  • mode - The type3 font mode.
    Allowed Values:
    • raster — Rasters Type 3 fonts into images, ensuring an exact visual representation in the HTML output.
    • convert — Attempts to convert Type 3 fonts to a web font, resulting in smaller file sizes with some possible visual discrepancies.
    Default:
    raster

public PdfToHtmlClient setSplitLigatures(bool value)

Converts ligatures, two or more letters combined into a single glyph, back into their individual ASCII characters.

Parameter:
  • value (bool) - Set to true to split ligatures.
    Default:
    false

public PdfToHtmlClient setCustomCss(string css)

Apply custom CSS to the output HTML document. It allows you to modify the visual appearance and layout. Tip: Using !important in custom CSS provides a way to prioritize and override conflicting styles.

Availability:
API client >= 6.2.0, converter >= 24.04. See versioning.
Parameter:
  • css - A string containing valid CSS.
Example:
  • Set the main background color to azure: setCustomCss("#page-container { background-color: azure; }")

public PdfToHtmlClient setHtmlNamespace(string prefix)

Add the specified prefix to all id and class attributes in the HTML content, creating a namespace for safe integration into another HTML document. This ensures unique identifiers, preventing conflicts when merging with other HTML.

Availability:
API client >= 6.3.0, converter >= 24.04. See versioning.
Parameter:
  • prefix - The prefix to add before each id and class attribute name.
    Constraint:
    • Start with a letter or underscore, and use only letters, numbers, hyphens, underscores, or colons.
Examples:
  • Namespace for first PDF embed: setHtmlNamespace("pdf1_")
  • Custom namespace to avoid conflicts: setHtmlNamespace("uniqueID123_")

public bool isZippedOutput()

A helper method to determine if the output file is a zip archive. The output of the conversion may be either an HTML file or a zip file containing the HTML and its external assets.

Returns:
bool - True if the conversion output is a zip file, otherwise False.

public PdfToHtmlClient setForceZip(bool value)

Enforces the zip output format.

Parameter:
  • value (bool) - Set to true to get the output as a zip archive.
    Default:
    false

public PdfToHtmlClient setTitle(string title)

Set the HTML title. The title from the input PDF is used by default.

Parameter:
  • title - The HTML title.

public PdfToHtmlClient setSubject(string subject)

Set the HTML subject. The subject from the input PDF is used by default.

Parameter:
  • subject - The HTML subject.

public PdfToHtmlClient setAuthor(string author)

Set the HTML author. The author from the input PDF is used by default.

Parameter:
  • author - The HTML author.

public PdfToHtmlClient setKeywords(string keywords)

Associate keywords with the HTML document. Keywords from the input PDF are used by default.

Parameter:
  • keywords - The string containing the keywords.

Miscellaneous

public PdfToHtmlClient setDebugLog(bool value)

Turn on the debug logging. Details about the conversion are stored in the debug log. The URL of the log can be obtained from the getDebugLogUrl method or available in conversion statistics.

Parameter:
  • value (bool) - Set to true to enable the debug logging.
    Default:
    false

public string getDebugLogUrl()

Get the URL of the debug log for the last conversion.

Returns:
string - The link to the debug log.

public int getRemainingCreditCount()

Get the number of conversion credits available in your account.
This method can only be called after a call to one of the convertXtoY methods.
The returned value can differ from the actual count if you run parallel conversions.
The special value 999999 is returned if the information is not available.

Returns:
int - The number of credits.

public int getConsumedCreditCount()

Get the number of credits consumed by the last conversion.

Returns:
int - The number of credits.

public string getJobId()

Get the job id.

Returns:
string - The unique job identifier.

public int getPageCount()

Get the number of pages in the output document.

Returns:
int - The page count.

public int getOutputSize()

Get the size of the output in bytes.

Returns:
int - The count of bytes.

public string getVersion()

Get the version details.

Returns:
string - API version, converter version, and client version.

public PdfToHtmlClient setTag(string tag)

Tag the conversion with a custom value. The tag is used in conversion statistics. A value longer than 32 characters is cut off.

Parameter:
  • tag - A string with the custom tag.
Example:
  • Track job in analytics: setTag("client-1234")

public PdfToHtmlClient setHttpProxy(string proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Corporate proxy server: setHttpProxy("myproxy.com:8080")
  • Direct IP proxy connection: setHttpProxy("113.25.84.10:33333")

public PdfToHtmlClient setHttpsProxy(string proxy)

A proxy server used by the conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.

Parameter:
  • proxy
    Constraint:
    • The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • Secure proxy for HTTPS: setHttpsProxy("myproxy.com:443")
  • Direct secure proxy IP: setHttpsProxy("113.25.84.10:44333")

API Client Options

public PdfToHtmlClient setConverterVersion(string version)

Set the converter version. Different versions may produce different output. Choose which one provides the best output for your case.

Availability:
API client >= 5.0.0. See versioning.
Parameter:
  • version - The version identifier.
    Allowed Values:
    • 24.04 — Version 24.04.
    • 20.10 — Version 20.10.
    • 18.10 — Version 18.10.
    • latest — Version 20.10 is used.
    Default:
    24.04

public PdfToHtmlClient setUseHttp(bool value)

Specify whether to use HTTP or HTTPS when connecting to the PDFCrowd API.

Parameter:
  • value (bool) - Set to true to use HTTP.
    Default:
    false

public PdfToHtmlClient setClientUserAgent(string agent)

Specifies the User-Agent HTTP header that the client library will use when interacting with the API.

Availability:
API client >= 6.4.0 See versioning.
Parameter:
  • agent - The user agent string.

public PdfToHtmlClient setUserAgent(string agent)

Deprecated Replaced with: setClientUserAgent

Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.

Parameter:
  • agent - The user agent string.
    Default:
    pdfcrowd_dotnet_client/6.5.3 (https://pdfcrowd.com)

public PdfToHtmlClient setProxy(string host, int port, string userName, string password)

Specifies an HTTP proxy that the API client library will use to connect to the internet.

Parameters:
  • host - The proxy hostname.
  • port (int) - The proxy port.
  • userName - The username.
  • password - The password.

public PdfToHtmlClient setRetryCount(int count)

Specifies the number of automatic retries when the 502 or 503 HTTP status code is received. The status code indicates a temporary network issue. This feature can be disabled by setting to 0.

Parameter:
  • count (int) - Number of retries.
    Default:
    1
Example:
  • Retry failed requests three times: setRetryCount(3)