Struct SizeConstraint

Namespace

Kentico.Content.Web.Mvc

Assembly

Kentico.Content.Web.Mvc.dll

Represents a size constraint that can be enforced on image when resizing.

public struct SizeConstraint

Extension Methods

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

QueryExtensions.AsLiteral<T>(T)

QueryExtensions.AsValue<T>(T, bool)

Fields

Empty

Gets a SizeConstraint structure that has width, height and maximum width or height of 0.

public static readonly SizeConstraint Empty

Field Value

SizeConstraint

Properties

HeightComponent

Gets the desired image height, in pixels.

public int HeightComponent { get; }

Property Value

int

IsEmpty

Tests whether this structure has width, height and maximum width or height of 0.

public bool IsEmpty { get; }

Property Value

bool

MaxWidthOrHeightComponent

Gets the desired maximum image width or height.

public int MaxWidthOrHeightComponent { get; }

Property Value

int

WidthComponent

Gets the desired image width, in pixels.

public int WidthComponent { get; }

Property Value

int

Methods

Equals(object)

Determines whether the specified object is a SizeConstraint structure with the same width, height and maximum width or height as this SizeConstraint structure.

public override bool Equals(object other)

Parameters

other object

The object to compare.

Returns

bool

True if other is a SizeConstraint and has the same width, height and maximum width or height; otherwise, false.

GetHashCode()

Returns a hash code for this SizeConstraint structure.

public override int GetHashCode()

Returns

int

A hash code for this SizeConstraint structure.

Height(int)

Creates a new size constraint that makes the image resize to the specified height. This constraint maintains the aspect ratio. The resized image is never made larger than the original.

public static SizeConstraint Height(int height)

Parameters

height int

The height of the resized image.

Returns

SizeConstraint

The new size constraint that makes the image resize to the specified height.

Exceptions

ArgumentOutOfRangeException

Height is less than or equal to 0.

MaxWidthOrHeight(int)

Creates a new size constraint that makes the image resize to the width and height that do not exceed the specified value. This constraint maintains the aspect ratio. The resized image is never made larger than the original.

public static SizeConstraint MaxWidthOrHeight(int maxWidthOrHeight)

Parameters

maxWidthOrHeight int

Maximum width or height of the resized image.

Returns

SizeConstraint

The new size constraint that makes the image resize to the width and height that do not exceed the specified value.

Exceptions

ArgumentOutOfRangeException

Maximum width or height is less than or equal to 0.

Size(int, int)

Creates a new size constraint that makes the image resize to the specified width and height. This constraint does not maintain the aspect ratio. The resized image is never made larger than the original.

public static SizeConstraint Size(int width, int height)

Parameters

width int

The width of the resized image.

height int

The height of the resized image.

Returns

SizeConstraint

The new size constraint that makes the image resize to the specified width and height.

Exceptions

ArgumentOutOfRangeException

Width or height is less than or equal to 0.

ToString()

Creates a human-readable string that represents this SizeConstraint structure.

public override string ToString()

Returns

string

A human-readable string that represents this SizeConstraint structure.

Width(int)

Creates a new size constraint that makes the image resize to the specified width. This constraint maintains the aspect ratio. The resized image is never made larger than the original.

public static SizeConstraint Width(int width)

Parameters

width int

The width of the resized image.

Returns

SizeConstraint

The new size constraint that makes the image resize to the specified width.

Exceptions

ArgumentOutOfRangeException

Width is less than or equal to 0.

Operators

operator ==(SizeConstraint, SizeConstraint)

Determines whether two SizeConstraint structures are equal.

public static bool operator ==(SizeConstraint x, SizeConstraint y)

Parameters

x SizeConstraint

The SizeConstraint structure on the left side of the equality operator.

y SizeConstraint

The SizeConstraint structure on the right side of the equality operator.

Returns

bool

True if x and y have equal width, height and maximum width or height; otherwise, false.

operator !=(SizeConstraint, SizeConstraint)

Determines whether two SizeConstraint structures are different.

public static bool operator !=(SizeConstraint x, SizeConstraint y)

Parameters

x SizeConstraint

The SizeConstraint structure on the left side of the inequality operator.

y SizeConstraint

The SizeConstraint structure on the right side of the inequality operator.

Returns

bool

True if x and y differ in width or height or maximum width or height; otherwise, true.