Class ImageCropperValue

Represents a value of the image cropper value editor.

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.PropertyEditors.ValueConverters

Assembly: cs.temp.dll.dll

Syntax

public class ImageCropperValue : IHtmlEncodedString, IEquatable<ImageCropperValue>

Properties

Crops

Gets or sets the value crops.

Declaration

public IEnumerable<ImageCropperValue.ImageCropperCrop> Crops { get; set; }

Property Value

Type	Description
System.Collections.Generic.IEnumerable<ImageCropperValue.ImageCropperCrop>

FocalPoint

Gets or sets the value focal point.

Declaration

public ImageCropperValue.ImageCropperFocalPoint FocalPoint { get; set; }

Property Value

Type	Description
ImageCropperValue.ImageCropperFocalPoint

Src

Gets or sets the value source image.

Declaration

public string Src { get; set; }

Property Value

Type	Description
System.String

Methods

Equals(Object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj

Returns

Type	Description
System.Boolean

Equals(ImageCropperValue)

Declaration

public bool Equals(ImageCropperValue other)

Parameters

Type	Name	Description
ImageCropperValue	other

Returns

Type	Description
System.Boolean

GetCrop(String)

Gets a crop.

Declaration

public ImageCropperValue.ImageCropperCrop GetCrop(string alias)

Parameters

Type	Name	Description
System.String	alias

Returns

Type	Description
ImageCropperValue.ImageCropperCrop

GetCropBaseOptions(String, ImageCropperValue.ImageCropperCrop, Boolean)

Declaration

public ImageUrlGenerationOptions GetCropBaseOptions(string url, ImageCropperValue.ImageCropperCrop crop, bool preferFocalPoint)

Parameters

Type	Name	Description
System.String	url
ImageCropperValue.ImageCropperCrop	crop
System.Boolean	preferFocalPoint

Returns

Type	Description
ImageUrlGenerationOptions

GetCropUrl(Int32, Int32, IImageUrlGenerator, String)

Gets the value image URL for a specific width and height.

Declaration

public string GetCropUrl(int width, int height, IImageUrlGenerator imageUrlGenerator, string cacheBusterValue = null)

Parameters

Type	Name	Description
System.Int32	width
System.Int32	height
IImageUrlGenerator	imageUrlGenerator
System.String	cacheBusterValue

Returns

Type	Description
System.String

GetCropUrl(String, IImageUrlGenerator, Boolean, Boolean, String)

Gets the value image URL for a specified crop.

Declaration

public string GetCropUrl(string alias, IImageUrlGenerator imageUrlGenerator, bool useCropDimensions = true, bool useFocalPoint = false, string cacheBusterValue = null)

Parameters

Type	Name	Description
System.String	alias
IImageUrlGenerator	imageUrlGenerator
System.Boolean	useCropDimensions
System.Boolean	useFocalPoint
System.String	cacheBusterValue

Returns

Type	Description
System.String

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32

HasCrop(String)

Determines whether the value has a specified crop.

Declaration

public bool HasCrop(string alias)

Parameters

Type	Name	Description
System.String	alias

Returns

Type	Description
System.Boolean

HasCrops()

Determines whether the value has crops.

Declaration

public bool HasCrops()

Returns

Type	Description
System.Boolean

HasFocalPoint()

Determines whether the value has a focal point.

Declaration

public bool HasFocalPoint()

Returns

Type	Description
System.Boolean

HasImage()

Determines whether the value has a source image.

Declaration

public bool HasImage()

Returns

Type	Description
System.Boolean

Merge(ImageCropperValue)

Declaration

public ImageCropperValue Merge(ImageCropperValue imageCropperValue)

Parameters

Type	Name	Description
ImageCropperValue	imageCropperValue

Returns

Type	Description
ImageCropperValue

Prune(JObject)

Removes redundant crop data/default focal point.

Declaration

public static void Prune(JObject value)

Parameters

Type	Name	Description
JObject	value	The image cropper value.

ToHtmlString()

Declaration

public string ToHtmlString()

Returns

Type	Description
System.String

ToString()

Declaration

public override string ToString()

Returns

Type	Description
System.String

Operators

Equality(ImageCropperValue, ImageCropperValue)

Declaration

public static bool operator ==(ImageCropperValue left, ImageCropperValue right)

Parameters

Type	Name	Description
ImageCropperValue	left
ImageCropperValue	right

Returns

Type	Description
System.Boolean

Inequality(ImageCropperValue, ImageCropperValue)

Declaration

public static bool operator !=(ImageCropperValue left, ImageCropperValue right)

Parameters

Type	Name	Description
ImageCropperValue	left
ImageCropperValue	right

Returns

Type	Description
System.Boolean