Image to Image / .NET Reference

class ImageToImageClient

All setter methods return ImageToImageClient object unless specified otherwise.

Constructor

public ImageToImageClient(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.

Conversion Format

public ImageToImageClient setOutputFormat(string outputFormat)
The format of the output file.
outputFormat
Allowed values:
  • png
  • jpg
  • gif
  • tiff
  • bmp
  • ico
  • ppm
  • pgm
  • pbm
  • pnm
  • psb
  • pct
  • ras
  • tga
  • sgi
  • sun
  • webp
Default: png

Image Operations

Settings used for operations with images.

public ImageToImageClient setResize(string resize)
Resize the image.
resize
The resize percentage or new image dimensions.
Default: 100%
Examples:
  • setResize("200%")
  • setResize("1024x768") 
public ImageToImageClient setRotate(string rotate)
Rotate the image.
rotate
The rotation specified in degrees.
Default: 0 
public ImageToImageClient setCropAreaX(string x)
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
x
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • setCropAreaX("-1in")
  • setCropAreaX("2.5cm") 
public ImageToImageClient setCropAreaY(string y)
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
y
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
Examples:
  • setCropAreaY("-1in")
  • setCropAreaY("2.5cm") 
public ImageToImageClient setCropAreaWidth(string width)
Set the width of the content area. It should be at least 1 inch.
width
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The width of the print area.
Examples:
  • setCropAreaWidth("8in")
  • setCropAreaWidth("25cm") 
public ImageToImageClient setCropAreaHeight(string height)
Set the height of the content area. It should be at least 1 inch.
height
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The height of the print area.
Examples:
  • setCropAreaHeight("8in")
  • setCropAreaHeight("25cm") 
public ImageToImageClient setCropArea(string x, string y, string width, string height)
Set the content area position and size. The content area enables to specify the part to be converted.
x
Set the top left X coordinate of the content area. It is relative to the top left X coordinate of the print area.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
y
Set the top left Y coordinate of the content area. It is relative to the top left Y coordinate of the print area.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: 0px
width
Set the width of the content area. It should be at least 1 inch.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The width of the print area.
height
Set the height of the content area. It should be at least 1 inch.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Default: The height of the print area. 
public ImageToImageClient setRemoveBorders(bool value)
Remove borders of an image which does not change in color.
value
Set to true to remove borders.
Default: false

Canvas Setup

public ImageToImageClient setCanvasSize(string size)
Set the output canvas size.
size
Allowed values:
  • A0
  • A1
  • A2
  • A3
  • A4
  • A5
  • A6
  • Letter
public ImageToImageClient setCanvasWidth(string width)
Set the output canvas width.
width
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setCanvasWidth("300mm")
  • setCanvasWidth("9.5in") 
public ImageToImageClient setCanvasHeight(string height)
Set the output canvas height.
height
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setCanvasHeight("15.25in")
  • setCanvasHeight("350mm") 
public ImageToImageClient setCanvasDimensions(string width, string height)
Set the output canvas dimensions. If no canvas size is specified, margins are applied as a border around the image.
width
Set the output canvas width.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
height
Set the output canvas height.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setCanvasDimensions("300mm", "350mm")
  • setCanvasDimensions("9.5in", "15.25in")
  • setCanvasDimensions("372mm", "520pt") 
public ImageToImageClient setOrientation(string orientation)
Set the output canvas orientation.
orientation
Allowed values:
  • landscape
  • portrait
Default: portrait 
public ImageToImageClient setPosition(string position)
Set the image position on the canvas.
position
Allowed values:
  • center
  • top
  • bottom
  • left
  • right
  • top-left
  • top-right
  • bottom-left
  • bottom-right
Default: center 
public ImageToImageClient setPrintCanvasMode(string mode)
Set the mode to print the image on the canvas.
mode
Allowed values:
  • default
    No image scaling.
  • fit
    Fit the image to the canvas with aspect ratio.
  • stretch
    Stretch the image to the canvas with no aspect ratio.
Default: default 
public ImageToImageClient setMarginTop(string top)
Set the output canvas top margin.
top
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setMarginTop("1in")
  • setMarginTop("2.5cm") 
public ImageToImageClient setMarginRight(string right)
Set the output canvas right margin.
right
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setMarginRight("1in")
  • setMarginRight("2.5cm") 
public ImageToImageClient setMarginBottom(string bottom)
Set the output canvas bottom margin.
bottom
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setMarginBottom("1in")
  • setMarginBottom("2.5cm") 
public ImageToImageClient setMarginLeft(string left)
Set the output canvas left margin.
left
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
Examples:
  • setMarginLeft("1in")
  • setMarginLeft("2.5cm") 
public ImageToImageClient setMargins(string top, string right, string bottom, string left)
Set the output canvas margins.
top
Set the output canvas top margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
right
Set the output canvas right margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
bottom
Set the output canvas bottom margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
left
Set the output canvas left margin.
The value must be specified in inches "in", millimeters "mm", centimeters "cm", pixels "px", or points "pt".
public ImageToImageClient setCanvasBackgroundColor(string color)
The canvas background color in RGB or RGBA hexadecimal format. The color fills the entire canvas regardless of margins. If no canvas size is specified and the image format supports background (e.g. PDF, PNG), the background color is applied too.
color
The value must be in RRGGBB or RRGGBBAA hexadecimal format.
Examples:
  • red color
    setCanvasBackgroundColor("FF0000")
  • green color
    setCanvasBackgroundColor("00ff00")
  • green color with 50% opacity
    setCanvasBackgroundColor("00ff0080") 
public ImageToImageClient setDpi(int dpi)
Set the DPI resolution of the input image. The DPI affects margin options specified in points too (e.g. 1 point is equal to 1 pixel in 96 DPI).
dpi
The DPI value.
Default: 96
Example:
  • The DPI used for printers. 1 inch contains 300 points.
    setDpi(300)

Miscellaneous

public ImageToImageClient 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 ImageToImageClient 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 ImageToImageClient 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 ImageToImageClient 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 ImageToImageClient 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:
  • 24.04
    Version 24.04.
  • 20.10
    Version 20.10.
  • 18.10
    Version 18.10.
Default: 24.04 
public ImageToImageClient 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 ImageToImageClient 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/6.3.0 (https://pdfcrowd.com) 
public ImageToImageClient 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 ImageToImageClient 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.
count
Number of retries.
Default: 1
Example:
  • setRetryCount(3)