PDF to PDF API - .Net

Join multiple PDF files in .Net using the Pdfcrowd API v2. The API is easy to use and the integration takes only a couple of lines of code.

Installation

Download pdfcrowd-4.11.0-dotnet.zip, unzip it and add a reference to pdfcrowd.dll to your project.

Learn more about other install options.

Authentication

Authentication is needed in order to use the Pdfcrowd API. The credentials used for accessing the API are your Pdfcrowd username and the API key.
Sign up for a Free Trial

Examples

Join 4 local PDF files together to a PDF file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Join 4 local PDF files together to in-memory PDF

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // create output file for conversion result
            FileStream outputFile = new FileStream("offer.pdf", FileMode.CreateNew);

            // run the conversion and store the result into a pdf variable
            byte[] pdf = client.convert();

            // write the pdf into the output file
            outputFile.Write(pdf, 0, pdf.Length);

            // close the output file
            outputFile.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Join 4 local PDF files together and write the resulting PDF to an output stream

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfFile("/path/to/cover.pdf");
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfFile("/path/to/price.pdf");
            client.addPdfFile("/path/to/contact.pdf");

            // create output stream for conversion result
            FileStream outputStream = new FileStream("offer.pdf", FileMode.CreateNew);

            // run the conversion and write the result into the output stream
            client.convertToStream(outputStream);

            // close the output stream
            outputStream.Close();
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Join 4 in-memory PDFs together to a PDF file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfRawData(File.ReadAllBytes("/path/to/cover.pdf"));
            client.addPdfRawData(File.ReadAllBytes("/path/to/proposal.pdf"));
            client.addPdfRawData(File.ReadAllBytes("/path/to/price.pdf"));
            client.addPdfRawData(File.ReadAllBytes("/path/to/contact.pdf"));

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Join 2 in-memory PDFs together with 2 local PDF files to a PDF file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfRawData(File.ReadAllBytes("/path/to/cover.pdf"));
            client.addPdfFile("/path/to/proposal.pdf");
            client.addPdfRawData(File.ReadAllBytes("/path/to/price.pdf"));
            client.addPdfFile("/path/to/contact.pdf");

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Add a watermark to a PDF file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfFile("/path/to/proposal.pdf");
            client.setPageWatermark("/path/to/watermark.pdf");

            // run the conversion and write the result to a file
            client.convertToFile("company_offer.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Linearize a PDF file

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.addPdfFile("/path/to/not_linearized.pdf");
            client.setLinearize(true);

            // run the conversion and write the result to a file
            client.convertToFile("linearized.pdf");
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Get info about the current conversion

using System;
using System.IO;

public class ApiTest
{
    public static void Main()
    {
        try
        {
            // create the API client instance
            pdfcrowd.PdfToPdfClient client = new pdfcrowd.PdfToPdfClient(
                "demo", "ce544b6ea52a5621fb9d55f8b542d14d");

            // configure the conversion
            client.setDebugLog(true);
            client.addPdfRawData(File.ReadAllBytes("/path/to/cover.pdf"));
            client.addPdfRawData(File.ReadAllBytes("/path/to/proposal.pdf"));

            // run the conversion and write the result to a file
            client.convertToFile("offer.pdf");
            
            // print URL to the debug log
            System.Console.WriteLine("Debug log url: " + client.getDebugLogUrl());
            
            // print the number of available conversion credits in your account
            System.Console.WriteLine("Remaining credit count: " + client.getRemainingCreditCount());
            
            // print the number of credits consumed by the conversion
            System.Console.WriteLine("Consumed credit count: " + client.getConsumedCreditCount());
            
            // print the unique ID of the conversion
            System.Console.WriteLine("Job id: " + client.getJobId());
            
            // print the total number of pages in the output document
            System.Console.WriteLine("Page count: " + client.getPageCount());
            
            // print the size of the output in bytes
            System.Console.WriteLine("Output size: " + client.getOutputSize());
        }
        catch(pdfcrowd.Error why)
        {
            // report the error
            System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

            // handle the exception here or rethrow and handle it at a higher level
            throw;
        }
    }
}

Error Handling

try 
{
    // call the API 
}
catch(pdfcrowd.Error why) 
{
    // print error
    System.Console.Error.WriteLine("Pdfcrowd Error: " + why);

    // print just error code
    System.Console.Error.WriteLine("Pdfcrowd Error Code: " + why.getCode());

    // print just error message
    System.Console.Error.WriteLine("Pdfcrowd Error Message: " + why.getMessage());

    // or handle the error in your way
}

Troubleshooting

Check API Status Codes in case of the error code is returned.
You can use setDebugLog and getDebugLogUrl to get detailed info about the conversion, such as conversion errors, time, console output.
Take a look at the FAQ section.

API Reference - class PdfToPdfClient

Conversion from PDF to PDF. All setter methods return PdfToPdfClient object unless otherwise specified.

Constructor

public PdfToPdfClient(string userName, string apiKey)

Constructor for the Pdfcrowd API client.

userName

Your username at Pdfcrowd.

apiKey

Your API key.

PDF Manipulation

public PdfToPdfClient setAction(string action)

Specifies the action to be performed on the input PDFs.

action

Allowed values:

join

Concatenate input PDFs into a single one.
shuffle

Collate pages from input PDFs into a single one, take one page at a time from each input PDF. This is useful when combining two scanned documents containing odd and even pages.

Default: join

public byte[] convert()

Perform an action on the input files.

Returns

byte[] - Byte array containing the output PDF.

public void convertToStream(Stream outStream)

Perform an action on the input files and write the output PDF to an output stream.

outStream

The output stream that will contain the output PDF.

public void convertToFile(string filePath)

Perform an action on the input files and write the output PDF to a file.

filePath

The output file path.

The string must not be empty.

public PdfToPdfClient addPdfFile(string filePath)

Add a PDF file to the list of the input PDFs.

filePath

The file path to a local PDF file.

The file must exist and not be empty.

public PdfToPdfClient addPdfRawData(byte[] pdfRawData)

Add in-memory raw PDF data to the list of the input PDFs.
Typical usage is for adding PDF created by another Pdfcrowd converter.

Example in PHP:
$clientPdf2Pdf->addPdfRawData($clientHtml2Pdf->convertUrl('http://www.example.com'));

pdfRawData

The raw PDF data.

The input data must be PDF content.

Watermark & Background

public PdfToPdfClient setPageWatermark(string pageWatermark)

Apply the first page of the watermark PDF to every page of the output PDF.

pageWatermark

The file path to a local watermark PDF file.

The file must exist and not be empty.

public PdfToPdfClient setPageWatermarkUrl(string pageWatermarkUrl)

Load a watermark PDF from the specified URL and apply the first page of the watermark PDF to every page of the output PDF.

pageWatermarkUrl

The supported protocols are http:// and https://.

Examples:

setPageWatermarkUrl("http://myserver.com/watermark.pdf")

public PdfToPdfClient setMultipageWatermark(string multipageWatermark)

Apply each page of the specified watermark PDF to the corresponding page of the output PDF.

multipageWatermark

The file path to a local watermark PDF file.

The file must exist and not be empty.

public PdfToPdfClient setMultipageWatermarkUrl(string multipageWatermarkUrl)

Load a watermark PDF from the specified URL and apply each page of the specified watermark PDF to the corresponding page of the output PDF.

multipageWatermarkUrl

The supported protocols are http:// and https://.

Examples:

setMultipageWatermarkUrl("http://myserver.com/watermark.pdf")

public PdfToPdfClient setPageBackground(string pageBackground)

Apply the first page of the specified PDF to the background of every page of the output PDF.

pageBackground

The file path to a local background PDF file.

The file must exist and not be empty.

public PdfToPdfClient setPageBackgroundUrl(string pageBackgroundUrl)

Load a background PDF from the specified URL and apply the first page of the background PDF to every page of the output PDF.

pageBackgroundUrl

The supported protocols are http:// and https://.

Examples:

setPageBackgroundUrl("http://myserver.com/background.pdf")

public PdfToPdfClient setMultipageBackground(string multipageBackground)

Apply each page of the specified PDF to the background of the corresponding page of the output PDF.

multipageBackground

The file path to a local background PDF file.

The file must exist and not be empty.

public PdfToPdfClient setMultipageBackgroundUrl(string multipageBackgroundUrl)

Load a background PDF from the specified URL and apply each page of the specified background PDF to the corresponding page of the output PDF.

multipageBackgroundUrl

The supported protocols are http:// and https://.

Examples:

setMultipageBackgroundUrl("http://myserver.com/background.pdf")

PDF Format

Miscellaneous values for PDF output.

public PdfToPdfClient setLinearize(bool linearize)

Create linearized PDF. This is also known as Fast Web View.

linearize

Set to true to create linearized PDF.

Default: false

public PdfToPdfClient setEncrypt(bool encrypt)

Encrypt the PDF. This prevents search engines from indexing the contents.

encrypt

Set to true to enable PDF encryption.

Default: false

public PdfToPdfClient setUserPassword(string userPassword)

Protect the PDF with a user password. When a PDF has a user password, it must be supplied in order to view the document and to perform operations allowed by the access permissions.

userPassword

The user password.

public PdfToPdfClient setOwnerPassword(string ownerPassword)

Protect the PDF with an owner password. Supplying an owner password grants unlimited access to the PDF including changing the passwords and access permissions.

ownerPassword

The owner password.

public PdfToPdfClient setNoPrint(bool noPrint)

Disallow printing of the output PDF.

noPrint

Set to true to set the no-print flag in the output PDF.

Default: false

public PdfToPdfClient setNoModify(bool noModify)

Disallow modification of the output PDF.

noModify

Set to true to set the read-only only flag in the output PDF.

Default: false

public PdfToPdfClient setNoCopy(bool noCopy)

Disallow text and graphics extraction from the output PDF.

noCopy

Set to true to set the no-copy flag in the output PDF.

Default: false

Viewer Preferences

These preferences specify how a PDF viewer should present the document. The preferences may be ignored by some PDF viewers.

public PdfToPdfClient setPageLayout(string pageLayout)

Specify the page layout to be used when the document is opened.

pageLayout

Allowed values:

single-page

Display one page at a time.
one-column

Display the pages in one column.
two-column-left

Display the pages in two columns, with odd-numbered pages on the left.
two-column-right

Display the pages in two columns, with odd-numbered pages on the right.

public PdfToPdfClient setPageMode(string pageMode)

Specify how the document should be displayed when opened.

pageMode

Allowed values:

full-screen

Full-screen mode.
thumbnails

Thumbnail images are visible.
outlines

Document outline is visible.

public PdfToPdfClient setInitialZoomType(string initialZoomType)

Specify how the page should be displayed when opened.

initialZoomType

Allowed values:

fit-width

The page content is magnified just enough to fit the entire width of the page within the window.
fit-height

The page content is magnified just enough to fit the entire height of the page within the window.
fit-page

The page content is magnified just enough to fit the entire page within the window both horizontally and vertically. If the required horizontal and vertical magnification factors are different, use the smaller of the two, centering the page within the window in the other dimension.

public PdfToPdfClient setInitialPage(int initialPage)

Display the specified page when the document is opened.

initialPage

Must be a positive integer number.

public PdfToPdfClient setInitialZoom(int initialZoom)

Specify the initial page zoom in percents when the document is opened.

initialZoom

Must be a positive integer number.

public PdfToPdfClient setHideToolbar(bool hideToolbar)

Specify whether to hide the viewer application's tool bars when the document is active.

hideToolbar

Set to true to hide tool bars.

Default: false

public PdfToPdfClient setHideMenubar(bool hideMenubar)

Specify whether to hide the viewer application's menu bar when the document is active.

hideMenubar

Set to true to hide the menu bar.

Default: false

public PdfToPdfClient setHideWindowUi(bool hideWindowUi)

Specify whether to hide user interface elements in the document's window (such as scroll bars and navigation controls), leaving only the document's contents displayed.

hideWindowUi

Set to true to hide ui elements.

Default: false

public PdfToPdfClient setFitWindow(bool fitWindow)

Specify whether to resize the document's window to fit the size of the first displayed page.

fitWindow

Set to true to resize the window.

Default: false

public PdfToPdfClient setCenterWindow(bool centerWindow)

Specify whether to position the document's window in the center of the screen.

centerWindow

Set to true to center the window.

Default: false

public PdfToPdfClient setDisplayTitle(bool displayTitle)

Specify whether the window's title bar should display the document title. If false , the title bar should instead display the name of the PDF file containing the document.

displayTitle

Set to true to display the title.

Default: false

public PdfToPdfClient setRightToLeft(bool rightToLeft)

Set the predominant reading order for text to right-to-left. This option has no direct effect on the document's contents or page numbering but can be used to determine the relative positioning of pages when displayed side by side or printed n-up

rightToLeft

Set to true to set right-to-left reading order.

Default: false

Miscellaneous

public PdfToPdfClient setDebugLog(bool debugLog)

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.

debugLog

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 convertXYZ 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 total 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 PdfToPdfClient 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.

tag

A string with the custom tag.

API Client Options

public PdfToPdfClient setUseHttp(bool useHttp)

Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.

useHttp

Set to true to use HTTP.

Default: false

public PdfToPdfClient setUserAgent(string userAgent)

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

userAgent

The user agent string.

Default: pdfcrowd_dotnet_client/4.11.0 (http://pdfcrowd.com)

public PdfToPdfClient 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.

host

The proxy hostname.

port

The proxy port.

userName

The username.

password

The password.

public PdfToPdfClient setRetryCount(int retryCount)

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

retryCount

Number of retries wanted.

Default: 1