Class ImageUrlGenerationOptions

These are options that are passed to the IImageUrlGenerator implementation to determine the URL that is generated.

Inheritance

object

Namespace: Umbraco.Cms.Core.Models

Assembly: Umbraco.Core.dll

Syntax

public class ImageUrlGenerationOptions

Constructors

View Source

ImageUrlGenerationOptions(string?)

Initializes a new instance of the ImageUrlGenerationOptions class.

Declaration

public ImageUrlGenerationOptions(string? imageUrl)

Parameters

Type	Name	Description
string	imageUrl	The base image URL.

Properties

View Source

CacheBusterValue

Gets or sets a cache buster value to append to the URL.

Declaration

public string? CacheBusterValue { get; set; }

Property Value

Type	Description
string

View Source

Crop

Gets or sets the crop coordinates.

Declaration

public ImageUrlGenerationOptions.CropCoordinates? Crop { get; set; }

Property Value

Type	Description
ImageUrlGenerationOptions.CropCoordinates

View Source

FocalPoint

Gets or sets the focal point position for cropping.

Declaration

public ImageUrlGenerationOptions.FocalPointPosition? FocalPoint { get; set; }

Property Value

Type	Description
ImageUrlGenerationOptions.FocalPointPosition

View Source

Format

Gets or sets the image format to use (for example "webp").

Declaration

public string? Format { get; set; }

Property Value

Type	Description
string

View Source

FurtherOptions

Gets or sets additional options to append to the generated URL.

Declaration

public string? FurtherOptions { get; set; }

Property Value

Type	Description
string

View Source

Height

Gets or sets the desired output height in pixels.

Declaration

public int? Height { get; set; }

Property Value

Type	Description
int?

View Source

ImageCropAnchor

Gets or sets the image crop anchor position.

Declaration

public ImageCropAnchor? ImageCropAnchor { get; set; }

Property Value

Type	Description
ImageCropAnchor?

View Source

ImageCropMode

Gets or sets the image crop mode to use.

Declaration

public ImageCropMode? ImageCropMode { get; set; }

Property Value

Type	Description
ImageCropMode?

View Source

ImageUrl

Gets the base image URL.

Declaration

public string? ImageUrl { get; }

Property Value

Type	Description
string

View Source

Quality

Gets or sets the image quality (typically 0-100).

Declaration

public int? Quality { get; set; }

Property Value

Type	Description
int?

View Source

SourceHeight

Gets or sets the source height of the original image in pixels.

Declaration

public int? SourceHeight { get; set; }

Property Value

Type	Description
int?

View Source

SourceWidth

Gets or sets the source width of the original image in pixels.

Declaration

public int? SourceWidth { get; set; }

Property Value

Type	Description
int?

View Source

Width

Gets or sets the desired output width in pixels.

Declaration

public int? Width { get; set; }

Property Value

Type	Description
int?

Methods

View Source

Equals(object?)

Declaration

public override bool Equals(object? obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

View Source

Equals(ImageUrlGenerationOptions?)

Declaration

public bool Equals(ImageUrlGenerationOptions? other)

Parameters

Type	Name	Description
ImageUrlGenerationOptions	other

Returns

Type	Description
bool

View Source

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int