Image to PDF .NET Reference

class ImageToPdfClient

All setter methods return ImageToPdfClient object unless specified otherwise.

Constructor

public ImageToPdfClient(string userName, string apiKey)
Constructor for the Pdfcrowd API client.
userName
Your username at Pdfcrowd.
apiKey
Your API key.

Conversion Input

public byte[] convertUrl(string url)
Convert an image.
url
The address of the image to convert.
The supported protocols are http:// and https://.
Returns
  • byte[] - Byte array containing the conversion output.
public void convertUrlToStream(string url, Stream outStream)
Convert an image and write the result to an output stream.
url
The address of the image to convert.
The supported protocols are http:// and https://.
outStream
The output stream that will contain the conversion output.
public void convertUrlToFile(string url, string filePath)
Convert an image and write the result to a local file.
url
The address of the image to convert.
The supported protocols are http:// and https://.
filePath
The output file path.
public byte[] convertFile(string file)
Convert a local file.
file
The path to a local file to convert.
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.
file
The path to a local file to convert.
The file must exist and not be empty.
outStream
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.
file
The path to a local file to convert.
The file must exist and not be empty.
filePath
The output file path.
public byte[] convertRawData(byte[] data)
Convert raw data.
data
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.
data
The raw content to be converted.
outStream
The output stream that will contain the conversion output.
public void convertRawDataToFile(byte[] data, string filePath)
Convert raw data to a file.
data
The raw content to be converted.
filePath
The output file path.
public byte[] convertStream(Stream inStream)
Convert the contents of an input stream.
inStream
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.
inStream
The input stream with source data.
outStream
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.
inStream
The input stream with source data.
filePath
The output file path.

Image Operations

Settings used for operations with images.

public ImageToPdfClient setResize(string resize)
Resize the image.
resize
The resize percentage or new image dimensions.
Default: 100%
Examples:
  • setResize("200%")
  • setResize("1024x768")
public ImageToPdfClient setRotate(string rotate)
Rotate the image.
rotate
The rotation specified in degrees.
Default: 0

Miscellaneous

public ImageToPdfClient 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.
value
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 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 ImageToPdfClient 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.
Example:
  • setTag("client-1234")
public ImageToPdfClient setHttpProxy(string proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTP scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpProxy("myproxy.com:8080")
  • setHttpProxy("113.25.84.10:33333")
public ImageToPdfClient setHttpsProxy(string proxy)
A proxy server used by Pdfcrowd conversion process for accessing the source URLs with HTTPS scheme. It can help to circumvent regional restrictions or provide limited access to your intranet.
proxy
The value must have format DOMAIN_OR_IP_ADDRESS:PORT.
Examples:
  • setHttpsProxy("myproxy.com:443")
  • setHttpsProxy("113.25.84.10:44333")

API Client Options

public ImageToPdfClient 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.
version
The version identifier.
Allowed values:
  • latest
    The latest converter version.
  • 20.10
    Version 20.10.
  • 18.10
    Version 18.10.
Default: 20.10
public ImageToPdfClient setUseHttp(bool value)
Specifies if the client communicates over HTTP or HTTPS with Pdfcrowd API.
value
Set to true to use HTTP.
Default: false

Warning

Using HTTP is insecure as data sent over HTTP is not encrypted. Enable this option only if you know what you are doing.

public ImageToPdfClient setUserAgent(string agent)
Set a custom user agent HTTP header. It can be useful if you are behind a proxy or a firewall.
agent
The user agent string.
Default: pdfcrowd_dotnet_client/5.9.0 (https://pdfcrowd.com)
public ImageToPdfClient 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 ImageToPdfClient setRetryCount(int count)
Specifies the number of automatic 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.
count
Number of retries.
Default: 1
Example:
  • setRetryCount(3)