View Source

Class ImageCropperValueConverter

Represents a value converter for the image cropper value editor.

Inheritance

System.Object

PropertyValueConverterBase

Namespace: Umbraco.Cms.Core.PropertyEditors.ValueConverters

Assembly: Umbraco.Infrastructure.dll

Syntax

public class ImageCropperValueConverter : PropertyValueConverterBase, IDeliveryApiPropertyValueConverter, IPropertyValueConverter, IDiscoverable

Constructors

ImageCropperValueConverter(ILogger<ImageCropperValueConverter>)

Declaration

public ImageCropperValueConverter(ILogger<ImageCropperValueConverter> logger)

Parameters

Type	Name	Description
ILogger<ImageCropperValueConverter>	logger

ImageCropperValueConverter(ILogger<ImageCropperValueConverter>, IJsonSerializer)

Declaration

public ImageCropperValueConverter(ILogger<ImageCropperValueConverter> logger, IJsonSerializer jsonSerializer)

Parameters

Type	Name	Description
ILogger<ImageCropperValueConverter>	logger
IJsonSerializer	jsonSerializer

Methods

ConvertIntermediateToDeliveryApiObject(IPublishedElement, IPublishedPropertyType, PropertyCacheLevel, Object, Boolean, Boolean)

Declaration

public object ConvertIntermediateToDeliveryApiObject(IPublishedElement owner, IPublishedPropertyType propertyType, PropertyCacheLevel referenceCacheLevel, object inter, bool preview, bool expanding)

Parameters

Type	Name	Description
IPublishedElement	owner
IPublishedPropertyType	propertyType
PropertyCacheLevel	referenceCacheLevel
System.Object	inter
System.Boolean	preview
System.Boolean	expanding

Returns

Type	Description
System.Object

ConvertSourceToIntermediate(IPublishedElement, IPublishedPropertyType, Object, Boolean)

Converts a property source value to an intermediate value.

Declaration

public override object ConvertSourceToIntermediate(IPublishedElement owner, IPublishedPropertyType propertyType, object source, bool preview)

Parameters

Type	Name	Description
IPublishedElement	owner	The property set owning the property.
IPublishedPropertyType	propertyType	The property type.
System.Object	source	The source value.
System.Boolean	preview	A value indicating whether conversion should take place in preview mode.

Returns

Type	Description
System.Object	The result of the conversion.

Remarks

The converter should know how to convert a null source value, meaning that no value has been assigned to the property. The intermediate value can be null.

With the XML cache, source values come from the XML cache and therefore are strings.

With objects caches, source values would come from the database and therefore be either ints, DateTimes, decimals, or strings.

The converter should be prepared to handle both situations.

When source values are strings, the converter must handle empty strings, whitespace strings, and xml-whitespace strings appropriately, ie it should know whether to preserve white spaces.

GetDeliveryApiPropertyCacheLevel(IPublishedPropertyType)

Declaration

public PropertyCacheLevel GetDeliveryApiPropertyCacheLevel(IPublishedPropertyType propertyType)

Parameters

Type	Name	Description
IPublishedPropertyType	propertyType

Returns

Type	Description
PropertyCacheLevel

GetDeliveryApiPropertyValueType(IPublishedPropertyType)

Declaration

public Type GetDeliveryApiPropertyValueType(IPublishedPropertyType propertyType)

Parameters

Type	Name	Description
IPublishedPropertyType	propertyType

Returns

Type	Description
Type

GetPropertyCacheLevel(IPublishedPropertyType)

Gets the property cache level.

Declaration

public override PropertyCacheLevel GetPropertyCacheLevel(IPublishedPropertyType propertyType)

Parameters

Type	Name	Description
IPublishedPropertyType	propertyType	The property type.

Returns

Type	Description
PropertyCacheLevel	The property cache level.

GetPropertyValueType(IPublishedPropertyType)

Gets the type of values returned by the converter.

Declaration

public override Type GetPropertyValueType(IPublishedPropertyType propertyType)

Parameters

Type	Name	Description
IPublishedPropertyType	propertyType	The property type.

Returns

Type	Description
Type	The CLR type of values returned by the converter.

Remarks

Some of the CLR types may be generated, therefore this method cannot directly return a Type object (which may not exist yet). In which case it needs to return a ModelType instance.

IsConverter(IPublishedPropertyType)

Gets a value indicating whether the converter supports a property type.

Declaration

public override bool IsConverter(IPublishedPropertyType propertyType)

Parameters

Type	Name	Description
IPublishedPropertyType	propertyType	The property type.

Returns

Type	Description
System.Boolean	A value indicating whether the converter supports a property type.