ImageVariantDefinitionExtensions.GenerateVariant Method

Generates an image variant by applying all variant definition filters.

Namespace: CMS.ResponsiveImages
Assembly: CMS.ResponsiveImages (in CMS.ResponsiveImages.dll) Version: 10.0.0

Syntax

public static ImageContainer GenerateVariant(
	this IImageVariantDefinition imageVariantDefinition,
	ImageContainer imageContainer,
	IVariantContext context
)

Parameters

imageVariantDefinition

Type: CMS.ResponsiveImages.IImageVariantDefinition
Image variant definition.

imageContainer

Type: CMS.ResponsiveImages.ImageContainer
Source image data.

context

Type: CMS.ResponsiveImages.IVariantContext
Image processing context.

Return Value

Type: ImageContainer
New instance of ImageContainer with transformed image data or null when the definition is not applicable for the provided image.

Usage Note

In Visual Basic and C#, you can call this method as an instance method on any object of type IImageVariantDefinition. When you use instance method syntax to call this method, omit the first parameter. For more information, see Extension Methods (Visual Basic) or Extension Methods (C# Programming Guide).

Exceptions

Exception	Condition
ArgumentNullException	Thrown when either of the parameters is null.
ImageFilterException	Thrown when an error occurs during a filter application.