Class ImageHelper

Namespace

Dynamicweb.Imaging

Assembly

Dynamicweb.Core.dll

Helper class to generate preview link in format /Admin/Public/GetImage.ashx

public static class ImageHelper

Inheritance

object

ImageHelper

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Methods

TryGetImagePreviewPath(string, bool, out string)

Gets preview link for given image path

public static bool TryGetImagePreviewPath(string filePath, bool skipValidation, out string previewPath)

Parameters

filePath string

Image path for preview

skipValidation bool

Skip image validation (requires Admin authentication)

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image

TryGetImagePreviewPath(string, int, int, bool, out string)

Gets preview link for given image path and dimensions

public static bool TryGetImagePreviewPath(string filePath, int width, int height, bool skipValidation, out string previewPath)

Parameters

filePath string

Image path for preview

width int

Preview image width

height int

Preview image height

skipValidation bool

Skip image validation (requires Admin authentication)

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image

TryGetImagePreviewPath(string, int, int, out string)

Gets preview link for given image path and dimensions

public static bool TryGetImagePreviewPath(string filePath, int width, int height, out string previewPath)

Parameters

filePath string

Image path for preview

width int

Preview image width

height int

Preview image height

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image

TryGetImagePreviewPath(string, out string)

Gets preview link for given image path

public static bool TryGetImagePreviewPath(string filePath, out string previewPath)

Parameters

filePath string

Image path for preview

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image

TryGetImagePreviewPathFromParameters(ConvertParameters, bool, out string)

Gets preview link for given preview image conversion parameters

public static bool TryGetImagePreviewPathFromParameters(ConvertParameters convertParameters, bool skipValidation, out string previewPath)

Parameters

convertParameters ConvertParameters

Preview image conversion parameters

skipValidation bool

Skip image validation (requires Admin authentication)

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image

TryGetImagePreviewPathFromParameters(ConvertParameters, out string)

Gets preview link for given preview image conversion parameters

public static bool TryGetImagePreviewPathFromParameters(ConvertParameters convertParameters, out string previewPath)

Parameters

convertParameters ConvertParameters

Preview image conversion parameters

previewPath string

Output preview path as virtual path is it is IsImageFile(string), and as preview url if it is IsResizableImageFile(string)

Returns

bool

true

when given path is image