Class AutomaticImageFormatConversionParameters

Namespace

CMS.ContentEngine

Assembly

CMS.ContentEngine.dll

Configuration of the 'Automatic image format conversion' feature.

public class AutomaticImageFormatConversionParameters : IAutomaticImageFormatConversionConfiguration

Inheritance

object

AutomaticImageFormatConversionParameters

Implements

IAutomaticImageFormatConversionConfiguration

Extension Methods

DataExtensions.With<T>(T, Action<T>)

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Constructors

AutomaticImageFormatConversionParameters()

public AutomaticImageFormatConversionParameters()

Properties

HeightLimit

Maximum Image Height: If an image exceeds this specified limit, it will be resized to fit within the maximum height while preserving its aspect ratio, utilizing the 'Automatic Image Format Conversion' feature.

public int? HeightLimit { get; set; }

Property Value

int?

InputImageExtensions

File extensions that are processed by the 'Automatic image format conversion' pipeline.

public IEnumerable<string> InputImageExtensions { get; set; }

Property Value

IEnumerable<string>

IsFormatConversionEnabled

Indicates whether the 'Automatic image format conversion' feature is enabled.

public bool IsFormatConversionEnabled { get; set; }

Property Value

bool

OutputImageExtension

Image extension that is produced by the 'Automatic image format conversion' pipeline.

public string OutputImageExtension { get; set; }

Property Value

string

OutputQuality

Quality of the image that is produced by the 'Automatic image format conversion' pipeline.

public string OutputQuality { get; set; }

Property Value

string

WidthLimit

Maximum Image Width: If an image exceeds this specified limit, it will be resized to fit within the maximum width while preserving its aspect ratio, utilizing the 'Automatic Image Format Conversion' feature.

public int? WidthLimit { get; set; }

Property Value

int?

Methods

FromField(FormFieldInfo)

Returns the 'Automatic image format conversion' parameters in case the feature is enabled on field.

public static AutomaticImageFormatConversionParameters FromField(FormFieldInfo formField)

Parameters

formField FormFieldInfo

Returns

AutomaticImageFormatConversionParameters