Days
Hours
Minutes
Seconds
x

Froala Editor v4.2.0 is Here LEARN MORE

Skip to content

.NET SDK Image Reference

Upload (httpContext, fileRoute, options)

Returns: Object

Method used to upload an image to a specified location on disk.

Parameters:


  • httpContext

    All the HTTP specific information for the HTTP request.

    Type: HttpContext

  • fileRoute

    The server route for file uploads. This route must be public.

    Type: String

  • options

    This parameter is optional. It is used to pass custom options for the image upload.

    Short example:

    MagickGeometry resizeGeometry = new MagickGeometry(300, 300);
    resizeGeometry.IgnoreAspectRatio = true;
    
    /// Custom options.
    FroalaEditor.ImageOptions options = new FroalaEditor.ImageOptions
    {
    ResizeGeometry = resizeGeometry
    };

    Type: ImageOptions


options parameter:

  • Fieldname

    Tag name that points to the file.

    Type: String
    Default:
    "file"
  • Validation

    Specify the allowed image extensions and mimetypes.

    Type: ImageValidation
    Default:
    /// Allowed image validation default extensions.
    public static string[] AllowedImageExtsDefault = new string[] { "gif", "jpeg", "jpg", "png", "svg", "blob" };
    
    /// Allowed image validation default mimetypes.
    public static string[] AllowedImageMimetypesDefault = new string[] { "image/gif", "image/jpeg", "image/pjpeg", "image/x-png", "image/png", "image/svg+xml" };
    
  • ResizeGeometry

    Used to resize the image to a fixed size.

    Type: MagickGeometry
    Default:
    NULL

Response

If the upload is successful, the method returns an object with the absolute path to the uploaded image. If an error occurs, the method throws an exception.

try
{
return Json(FroalaEditor.Image.Upload(System.Web.HttpContext.Current, uploadPath));
}
catch (Exception e)
{
return Json(e);
}

Delete (filePath)

Method used to delete an image from disk. Throws an exception if an error occurs.

Parameters:


  • filePath

    The server image path.

    Type: String

List (folderPath, thumbPath)

Returns: List<object>

Method used to list all images from disk.

Parameters:


  • folderPath

    The path of the folder from where the images are being loaded.

    Type: String

  • thumbPath

    This parameter is optional. The path of the folder from where the image thumbs are being loaded.

    Type: String

Response

If the load is successful, the method returns a list with objects containing the image url, thumbnail and name. If an error occurs, the method throws an exception.

string uploadPath = "/Public/";

try
{
return Json(FroalaEditor.Image.List(uploadPath));
}
catch (Exception e)
{
return Json(e);
}

Do you think we can improve this article? Let us know.