Click or drag to resize

Using ImageUltimate in an ASP.NET Core project

To use ImageUltimate in an ASP.NET Core Project, do the following in Visual Studio:

  1. Make sure you have added references to ImageUltimate assemblies as described here.

    Note Note

    For an "ASP.NET Core on .NET Framework" project, make sure you have the following additional packages with these minimum versions in your project (update them in Nuget Package Manager if necessary):

    • Microsoft.AspNetCore 2.0.3+
    • Microsoft.AspNetCore.Mvc 2.0.3+
    • Microsoft.AspNetCore.Session 2.0.3+

    For an "ASP.NET Core on .NET Core" project, these dependencies will be pulled by NuGet Package Manager automatically so you don't need to do any additional steps.

  2. Open Startup.cs of your project.

    Add GleamTech to the ASP.NET Core services container. Insert the marked line into the ConfigureServices method of your Startup.cs:

    C#
    public void ConfigureServices(IServiceCollection services)
    {
        services.AddMvc();
    
    
        //Add GleamTech to the ASP.NET Core services container.
        //----------------------
        services.AddGleamTech();
        //----------------------
    }

    Register GleamTech to the ASP.NET Core HTTP request pipeline. Insert the marked line into the Configure method of your Startup.cs:

    C#
    public void Configure(IApplicationBuilder app, IHostingEnvironment env)
    {
        if (env.IsDevelopment())
        {
            app.UseBrowserLink();
            app.UseDeveloperExceptionPage();
        }
        else
        {
            app.UseExceptionHandler("/Home/Error");
        }
    
    
        //Register GleamTech to the ASP.NET Core HTTP request pipeline.
        //----------------------
        app.UseGleamTech();
        //----------------------
    
    
        app.UseStaticFiles();
    
        app.UseMvc(routes =>
        {
            routes.MapRoute(
                name: "default",
                template: "{controller=Home}/{action=Index}/{id?}");
        });
    }

    Note that order of app.UseXXX methods is important so app.UseGleamTech should be placed before app.UseStaticFiles and app.UseMvc.

  3. Set ImageUltimate's global configuration. For example, you may want to set the license key, the default path for finding source images and image cache location. Insert some of the following lines (if overriding a default value is required) after app.UseGleamTech call into the ConfigureServices method of your Startup.cs:

    C#
    //Set this property only if you have a valid license key, otherwise do not
    //set it so ImageUltimate runs in trial mode.
    ImageUltimateConfiguration.Current.LicenseKey = "QQJDJLJP34...";
    
    //The default SourcePath value is "~/App_Data/ImageSource"
    //Both virtual and physical paths are allowed.
    //Note that using a path under "~/App_Data" can have a benefit,
    //for instance if you want to protect your original source files, i.e.
    //prevent them from being downloaded directly, you can use this special 
    //folder which is restricted by ASP.NET runtime by default.
    ImageUltimateWebConfiguration.Current.SourcePath = "~/Content";
    
    //The default CacheLocation value is "~/App_Data/ImageCache"
    //Both virtual and physical paths are allowed (or a Location instance for one of the supported 
    //file systems like Amazon S3 and Azure Blob).
    //However it's recommended that you use a path inside your application folder 
    //(e.g. "~/SomeFolder", "/SomeFolder" or "C:\inetpub\wwwroot\MySite\SomeFolder")
    //so that ImageUltimate can use RewritePath to pass download requests directly
    //to IIS for higher throughput.
    ImageUltimateWebConfiguration.Current.CacheLocation = "~/App_Data/ImageCache";
    Tip Tip

    Alternatively you can specify the configuration in appsettings.json file.

    JavaScript
    {
      "ImageUltimate:LicenseKey": "QQJDJLJP34...",
      "ImageUltimateWeb:SourcePath": "~/Content",
      "ImageUltimateWeb:CacheLocation": "~/App_Data/ImageCache"
    }
    

    As you would notice, ImageUltimate: prefix maps to ImageUltimateConfiguration.Current and ImageUltimateWeb: prefix maps to ImageUltimateWebConfiguration.Current.

  4. Create a new View (eg. Index.cshtml) and insert these lines:

    C#
    @using GleamTech.ImageUltimate
    @using GleamTech.ImageUltimate.AspNet
    @using GleamTech.ImageUltimate.AspNet.Core
    
    <!DOCTYPE html>
    <html>
        <head>
            <title>Getting Started</title>
        </head>
        <body>
    
            @this.ImageTag("SomeImage.jpg", task => task.ResizeWidth(300))
    
        </body>
    </html>

    This will resize width of the source image ~/Content/SomeImage.jpg to 300 pixels (keeping aspect ratio), cache the resulting image and render a <img> tag in your page. For consecutive page views, the image will be served directly from the cache and no processing will be done. This is the reason the task (second parameter) is specified as a lambda function, it will be only called when necessary for maximum performance. Note that as we specified a non-rooted path for the image path (first parameter), the image is considered relative to ImageUltimateWebConfiguration.Current.SourcePath (as set in step 2). This allows you to write image commands as short lines and avoids parent path repetition.

    Sometimes you may need to render a url instead of a <img> tag, then use:

    C#
    @this.ImageUrl("SomeImage.jpg", task => task.ResizeWidth(300))

    For example, consider you want to add a background image to a CSS class:

    C#
    <style>
        .someCls
        {
            background-image: url(@this.ImageUrl("SomeImage.jpg", task => task.ResizeWidth(300)));
        }
    </style>
    Tip Tip

    Alternatively you can add the namespaces globally in Views/_ViewImports.cshtml to avoid adding namespaces in your pages every time.