.NET SDK

Overview

Cloudinary's .NET SDK provides simple, yet comprehensive image and video upload, transformation, optimization, and delivery capabilities that you can implement using code that integrates seamlessly with your existing .NET application.

This guide relates to the latest released version of the Cloudinary .NET library.

For details on all new features and fixes from previous versions, see the CHANGELOG.

Quick example: Transformations

Take a look at the following transformation code and the image it delivers:

.Net:
Copy to clipboard
cloudinary.Api.UrlImgUp.Transform(new Transformation()
  .Width(150).Height(150).Gravity("face").Crop("thumb").Chain()
  .Radius(20).Chain()
  .Effect("sepia").Chain()
  .Overlay(new Layer().PublicId("cloudinary_icon")).Gravity("south_east").X(5).Y(5).Width(50).Opacity(60).Effect("brightness:200").Chain()
  .Angle(10)).Secure(true).BuildImageTag("front_face.png")
sample transformation

This relatively simple code performs all of the following on the original front_face.jpg image before delivering it:

  • Crop to a 150x150 thumbnail using face-detection gravity to automatically determine the location for the crop
  • Round the corners with a 20 pixel radius
  • Apply a sepia effect
  • Overlay the Cloudinary logo on the southeast corner of the image (with a slight offset). The logo is scaled down to a 50 pixel width, with increased brightness and partial transparency (opacity = 60%)
  • Rotate the resulting image (including the overlay) by 10 degrees
  • Convert and deliver the image in PNG format (the originally uploaded image was a JPG)

And here's the URL that would be included in the image tag that's automatically generated from the above code:

Quick example: File upload

The following .NET code uploads the dog.mp4 video to the specified account sub-folder using the public_id, my_dog. The video will overwrite the existing my_dog video if it exists. When the video upload is complete, the specified notification URL will receive details about the uploaded media asset.

Copy to clipboard
var uploadParams = new VideoUploadParams()
    {
        File = new FileDescription(@"dog.mp4"),        
        PublicId = "my_folder/my_sub_folder/my_dog",
        Overwrite = true,
        NotificationUrl = "https://mysite/my_notification_endpoint"
    };
    var uploadResult = cloudinary.Upload(uploadParams);

.NET library features

Cloudinary provides an open source .NET library for further simplifying the integration:

  • Build URLs for image and video manipulations
  • View helper methods for embedding and transforming assets
  • API wrappers: file upload, administration, sprite generation and more
  • Server-side file upload + direct unsigned file upload from the browser using the jQuery plugin

The library is built for .NET Framework 4.x and .NET Core. You can use any .NET language with the library, and the library itself is written in C#. Our documentation includes examples both in C# and VB.NET.

Installation

The easiest way to start using Cloudinary's .NET library is to use Visual Studio and NuGet Package Manager. See NuGet Documentation for instructions of how to use NuGet packages. Below are the steps required to start a new project using Visual Studio and Cloudinary's .NET library.

  1. Download NuGet Package Manager at https://marketplace.visualstudio.com/items?itemName=NuGetTeam.NuGetPackageManager.
  2. Use Visual Studio to create a new project and choose the relevant .NET 4.x version as the target framework.
  3. Right click on the project in the Solution Explorer window and click on the menu item 'Manage NuGet packages...'
  4. Type CloudinaryDotNet in the search box at the upper right corner.
  5. When CloudinaryDotNet package appears, click on the Install button.
  6. After the package is installed, click the Close button.

Use CloudinaryDotNet and CloudinaryDotNet.Actions namespaces in your code:

For C#:

Copy to clipboard
using CloudinaryDotNet;
using CloudinaryDotNet.Actions;

For VB.NET:

Copy to clipboard
Imports CloudinaryDotNet
Imports CloudinaryDotNet.Actions

The library contains powerful helper methods for using directly from views. This documentation provides examples of the integration with Cloudinary's .NET library for the ASP.NET MVC v4.0 framework, for both Razor and ASPX view engines.

Using namespaces in view code:

For Razor/C#:

Copy to clipboard
@using CloudinaryDotNet
@using CloudinaryDotNet.Actions

For Razor/VB.NET:

Copy to clipboard
@Imports CloudinaryDotNet
@Imports CloudinaryDotNet.Actions

For ASPX (C# and VB.NET):

Copy to clipboard
<%@ Import Namespace="CloudinaryDotNet" %>
<%@ Import Namespace="CloudinaryDotNet.Actions" %>

Configuration

To use the Cloudinary .NET SDK, you have to configure at least your cloud_name. Your api_key and api_secret are also needed for secure API calls to Cloudinary (e.g., image and video uploads). You can find your account-specific configuration credentials in the Dashboard page of the account console.

Setting the configuration parameters can be done either programmatically using a constructor of the Cloudinary class or globally using an environment variable. You can optionally configure the required cloud_name, api_key, and api_secret by defining the CLOUDINARY_URL environment variable. The configuration URL is available in the Dashboard page of the account console. When using Cloudinary through a PaaS add-on (e.g., Heroku), this environment variable is automatically defined in your deployment environment. For example:

Copy to clipboard
CLOUDINARY_URL=cloudinary://my_key:my_secret@my_cloud_name

In addition to the required configuration parameters, you can define a number of optional configuration parameters if relevant.

Here's an example of setting configuration parameters in your .NET application:

For C#:

Copy to clipboard
Account account = new Account(
    "my_cloud_name",
    "my_api_key",
    "my_api_secret");

Cloudinary cloudinary = new Cloudinary(account);

For VB.NET:

Copy to clipboard
Dim account = New Account(
    "my_cloud_name",
    "my_api_key",
    "my_api_secret")

Dim cloudinary = New Cloudinary(account)

.NET capitalization and data type guidelines

When using the .NET SDK, keep these guidelines in mind:

  • Parameter names: PascalCase. For example: PublicId
  • Classes: PascalCase. For example: ImageUploadResults
  • Methods: PascalCase. For example: GetCloudinaryJsConfig
  • Pass parameter data as: Typed

Sample projects

To find additional useful code samples and learn how to integrate Cloudinary with your .NET applications, take a look at our Sample Projects. These projects are based on the ASP.NET MVC v4.0 framework and Razor view engine.

Basic sample: Uploading local and remote images to Cloudinary and generating various transformation URLs.

Photo Album: A fully working web application that allows you to uploads photos, maintain a database with references to them, list them with their metadata, and display them using various cloud-based transformations. Image uploading is performed both from the server side and directly from the browser using a jQuery plugin.

Related topics