Back to all docs
API Reference / Telerik.Maui.Controls.ImageEditor / AspectRatio
New to Telerik UI for .NET MAUI? Start a free 30-day trial

AspectRatio

Struct

Represents the aspect ratio expressed as the ratio between the width and height of an image.

Definition

Namespace:Telerik.Maui.Controls.ImageEditor

Assembly:Telerik.Maui.Controls.dll

Syntax:
C#
[TypeConverter(typeof(AspectRatioConverter))]
public struct AspectRatio : IEquatable<AspectRatio>

Implements: IEquatable<AspectRatio>

Constructors

AspectRatio(double, double)

Initializes a new instance of an aspect ratio with the specified components.

C#
public AspectRatio(double width, double height)
Parameters:widthdouble

Specifies the width component of the aspect ratio.

heightdouble

Specifies the height component of the aspect ratio.

Fields

Free

Special value, indicating the aspect ratio should not be constrained.

C#
public static readonly AspectRatio Free

Original

Special value, indicating the aspect ratio should match the original image.

C#
public static readonly AspectRatio Original

Square

Special value, indicating the width and height of the image should be equal.

C#
public static readonly AspectRatio Square

Methods

Equals(AspectRatio)

Compares the current aspect ratio with the specified one for equality.

C#
public bool Equals(AspectRatio aspectRatio)
Parameters:aspectRatioAspectRatio

Specifies the aspect ratio for comparison.

Returns:

bool

True, if the two aspect ratios are equal, false otherwise.

Implements: IEquatable<AspectRatio>.Equals(AspectRatio)

Equals(object)

Compares the current aspect ratio with the specified object for equality.

C#
public override bool Equals(object value)
Parameters:valueobject

Specifies the object value for comparison.

Returns:

bool

True, if the two objects are equal, false otherwise.

Overrides: ValueType.Equals(object)

GetHashCode()

Computes the hash code of the current aspect ratio.

C#
public override int GetHashCode()
Returns:

int

Overrides: ValueType.GetHashCode()

Parse(string)

Parses the specified string and converts it to an aspect ratio.

C#
public static AspectRatio Parse(string text)
Parameters:textstring

Specifies the input string to parse.

Returns:

AspectRatio

The converted aspect ratio on success.

Exceptions:

FormatException

If the specified string cannot be parsed.

ToDouble()

Converts the current aspect ratio to its floating-point representation.

C#
public double ToDouble()
Returns:

double

ToString()

Converts the current aspect ratio to its string representation.

C#
public override string ToString()
Returns:

string

Overrides: ValueType.ToString()

TryParse(string, out AspectRatio)

Parses the specified string and converts it to an aspect ratio.

C#
public static bool TryParse(string text, out AspectRatio aspectRatio)
Parameters:textstring

Specifies the input string to parse.

aspectRatioAspectRatio

Returns the converted aspect ratio on success.

Returns:

bool

True, if the parse operation is successful, false otherwise.

Operators

explicit operator double(AspectRatio)

Converts the specified aspect ratio to its floating-point representation.

C#
public static explicit operator double(AspectRatio aspectRatio)
Parameters:aspectRatioAspectRatio

Specifies the aspect ratio to convert.

Returns:

double

operator !=(AspectRatio, AspectRatio)

Compares the specified two aspect ratios for inequality.

C#
public static bool operator !=(AspectRatio leftOperand, AspectRatio rightOperand)
Parameters:leftOperandAspectRatio

Specifies the left operand for the comparison.

rightOperandAspectRatio

Specifies the right operand for the comparison.

Returns:

bool

True, if the two aspect ratios are not equal, false otherwise.

operator ==(AspectRatio, AspectRatio)

Compares the specified two aspect ratios for equality.

C#
public static bool operator ==(AspectRatio leftOperand, AspectRatio rightOperand)
Parameters:leftOperandAspectRatio

Specifies the left operand for the comparison.

rightOperandAspectRatio

Specifies the right operand for the comparison.

Returns:

bool

True, if the two aspect ratios are equal, false otherwise.

In this article
DefinitionConstructorsAspectRatio(double, double)FieldsFreeOriginalSquareMethodsEquals(AspectRatio)Equals(object)GetHashCode()Parse(string)ToDouble()ToString()TryParse(string, out AspectRatio)Operatorsexplicit operator double(AspectRatio)operator !=(AspectRatio, AspectRatio)operator ==(AspectRatio, AspectRatio)
Not finding the help you need?
Contact Support