Class HandlerImageProvider

Represents handler image provider.

Inheritance

System.Object

ImageProvider

HandlerImageProvider

Namespace: Mediachase.Commerce.Engine.Images.Providers

Assembly: Mediachase.Commerce.dll

Version: 10.8.0

Syntax

public class HandlerImageProvider : ImageProvider

Constructors

HandlerImageProvider()

Declaration

public HandlerImageProvider()

Properties

ApplicationName

Gets or sets the name of the application.

Declaration

public override string ApplicationName { get; set; }

Property Value

Type	Description
System.String	The name of the application.

Overrides

ImageProvider.ApplicationName

UrlFormatString

Gets or sets the URL format string.

Declaration

public string UrlFormatString { get; set; }

Property Value

Type	Description
System.String	The URL format string.

Methods

Exists(String)

Returns true if image with specified name already exists.

Declaration

public override bool Exists(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.Boolean

Overrides

ImageProvider.Exists(String)

Initialize(String, NameValueCollection)

Initializes the provider.

Declaration

public override void Initialize(string name, NameValueCollection config)

Parameters

Type	Name	Description
System.String	name	The friendly name of the provider.
System.Collections.Specialized.NameValueCollection	config	A collection of the name/value pairs representing the provider-specific attributes specified in the configuration for this provider.

Exceptions

Type	Condition
System.ArgumentNullException	The name of the provider is null.
System.InvalidOperationException	An attempt is made to call System.Configuration.Provider.ProviderBase.Initialize(System.String,System.Collections.Specialized.NameValueCollection) on a provider after the provider has already been initialized.
System.ArgumentException	The name of the provider has a length of zero.

RemoveImage(String)

Removes the image by name.

Declaration

public override void RemoveImage(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Overrides

ImageProvider.RemoveImage(String)

RetrieveImage(String)

Retrieves the image object.

Declaration

public override Image RetrieveImage(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.Drawing.Image

Overrides

ImageProvider.RetrieveImage(String)

RetrieveImageUrl(String)

Retrieves the image URL.

Declaration

public override string RetrieveImageUrl(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.String

Overrides

ImageProvider.RetrieveImageUrl(String)

RetrieveThumbnailImageUrl(String)

Retrieves the thumbnail image URL.

Declaration

public override string RetrieveThumbnailImageUrl(string name)

Parameters

Type	Name	Description
System.String	name	The name.

Returns

Type	Description
System.String

Overrides

ImageProvider.RetrieveThumbnailImageUrl(String)

SaveImage(String, Byte[])

Saves the image.

Declaration

public override void SaveImage(string name, byte[] image)

Parameters

Type	Name	Description
System.String	name	The name.
System.Byte[]	image	The image.

Overrides

ImageProvider.SaveImage(String, Byte[])

SaveImage(String, Byte[], ImageFormat)

Saves the image.

Declaration

public override void SaveImage(string name, byte[] image, ImageFormat format)

Parameters

Type	Name	Description
System.String	name	The name.
System.Byte[]	image	The image.
System.Drawing.Imaging.ImageFormat	format	Image format.

Overrides

ImageProvider.SaveImage(String, Byte[], ImageFormat)

SaveImage(String, Byte[], String)

Saves the image.

Declaration

public override void SaveImage(string name, byte[] image, string contentType)

Parameters

Type	Name	Description
System.String	name	The name.
System.Byte[]	image	The image.
System.String	contentType	Type of the content.

Overrides

ImageProvider.SaveImage(String, Byte[], String)

SaveImage(String, Image)

Saves the image.

Declaration

public override void SaveImage(string name, Image image)

Parameters

Type	Name	Description
System.String	name	The name.
System.Drawing.Image	image	The image.

Overrides

ImageProvider.SaveImage(String, Image)

SaveImage(String, Image, ImageFormat)

Saves the image.

Declaration

public override void SaveImage(string name, Image image, ImageFormat format)

Parameters

Type	Name	Description
System.String	name	The name.
System.Drawing.Image	image	The image.
System.Drawing.Imaging.ImageFormat	format	Image format.

Overrides

ImageProvider.SaveImage(String, Image, ImageFormat)

SaveImage(String, Image, String)

Saves the image.

Declaration

public override void SaveImage(string name, Image image, string contentType)

Parameters

Type	Name	Description
System.String	name	The name.
System.Drawing.Image	image	The image.
System.String	contentType	Type of the content.

Overrides

ImageProvider.SaveImage(String, Image, String)