Struct UIExtents

Definition

Namespace:

Tizen.NUI

Assembly:

Tizen.NUI.dll

Defines the thickness of a border around a control.

public struct UIExtents : IEquatable<UIExtents>

Implements

IEquatable<><UIExtents>

Constructors

UIExtents(float, float, float, float)

Initializes a new instance of the UIExtents struct with the specified left, top, right, and bottom sizes.

Declaration

public UIExtents(float start, float end, float top, float bottom)

Parameters

Type	Name	Description
float	start	The width of the left border.
float	end	The width of the right border.
float	top	The width of the top border.
float	bottom	The width of the bottom border.

UIExtents(float, float)

Initializes a new instance of the UIExtents struct with the specified horizontal and vertical sizes.

Declaration

public UIExtents(float horizontalSize, float verticalSize)

Parameters

Type	Name	Description
float	horizontalSize	The horizontal size of the borders.
float	verticalSize	The vertical size of the borders.

UIExtents(float)

Initializes a new instance of the UIExtents struct with the specified uniform size.

Declaration

public UIExtents(float uniformSize)

Parameters

Type	Name	Description
float	uniformSize	The uniform size of the borders.

Fields

Zero

Represents a UIExtents with all values set to 0.

Declaration

public static readonly UIExtents Zero

Field Value

Type	Description
UIExtents

Properties

Bottom

Gets or sets the width of the bottom border.

Declaration

public float Bottom { readonly get; init; }

Property Value

Type	Description
float

End

Gets or sets the width of the right border.

Declaration

public float End { readonly get; init; }

Property Value

Type	Description
float

HorizontalExtents

Gets the total width of the horizontal borders.

Declaration

public float HorizontalExtents { get; }

Property Value

Type	Description
float

IsNaN

Gets a value indicating whether any border has a width of NaN.

Declaration

public bool IsNaN { get; }

Property Value

Type	Description
bool

IsZero

Gets a value indicating whether this is zero.

Declaration

public readonly bool IsZero { get; }

Property Value

Type	Description
bool

Start

Gets or sets the width of the left border.

Declaration

public float Start { readonly get; init; }

Property Value

Type	Description
float

Top

Gets or sets the width of the top border.

Declaration

public float Top { readonly get; init; }

Property Value

Type	Description
float

VerticalExtents

Gets the total height of the vertical borders.

Declaration

public float VerticalExtents { get; }

Property Value

Type	Description
float

Methods

Deconstruct(out float, out float, out float, float)

Deconstructs the UIExtents into its individual components.

Declaration

public void Deconstruct(out float start, out float end, out float top, float bottom)

Parameters

Type	Name	Description
float	start	The width of the left border.
float	end	The width of the right border.
float	top	The width of the top border.
float	bottom	The width of the bottom border.

Equals(object)

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
object	obj

Returns

Type	Description
bool

Equals(UIExtents)

Whether this is equivalent to other.

Declaration

public bool Equals(UIExtents other)

Parameters

Type	Name	Description
UIExtents	other

Returns

Type	Description
bool

GetHashCode()

Declaration

public override int GetHashCode()

Returns

Type	Description
int

Operators

operator +(UIExtents, float)

Adds the specified to each component of the UIExtents.

Declaration

public static UIExtents operator +(UIExtents left, float addend)

Parameters

Type	Name	Description
UIExtents	left	The left operand.
float	addend	The float value to add.

Returns

Type	Description
UIExtents	A new UIExtents with the added values.

operator +(UIExtents, UIExtents)

Adds the specified UIExtents to the current UIExtents.

Declaration

public static UIExtents operator +(UIExtents left, UIExtents right)

Parameters

Type	Name	Description
UIExtents	left	The left operand.
UIExtents	right	The right operand.

Returns

Type	Description
UIExtents	A new UIExtents with the added values.

operator ==(UIExtents, UIExtents)

Compares two UIExtents objects for equality.

Declaration

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

Parameters

Type	Name	Description
UIExtents	left	The first UIExtents object to compare.
UIExtents	right	The second UIExtents object to compare.

Returns

Type	Description
bool	True if the objects are equal, otherwise false.

implicit operator UIExtents(float)

Implicitly converts a float to a UIExtents.

Declaration

public static implicit operator UIExtents(float uniformSize)

Parameters

Type	Name	Description
float	uniformSize	The uniform size to convert.

Returns

Type	Description
UIExtents

implicit operator Extents(UIExtents)

Converts the UIExtents to an Extents.

Declaration

public static implicit operator Extents(UIExtents uiExtents)

Parameters

Type	Name	Description
UIExtents	uiExtents	The UIExtents to convert.

Returns

Type	Description
Extents

operator !=(UIExtents, UIExtents)

Compares two UIExtents objects for inequality.

Declaration

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

Parameters

Type	Name	Description
UIExtents	left	The first UIExtents object to compare.
UIExtents	right	The second UIExtents object to compare.

Returns

Type	Description
bool	True if the objects are not equal, otherwise false.

operator -(UIExtents, float)

Subtracts the specified from each component of the UIExtents.

Declaration

public static UIExtents operator -(UIExtents left, float subtrahend)

Parameters

Type	Name	Description
UIExtents	left	The left operand.
float	subtrahend	The value to subtract.

Returns

Type	Description
UIExtents	A new UIExtents with the subtracted values.

Implements

IEquatable<>

Extension Methods

EXamlExtensions.LoadFromEXamlByRelativePath<T>(T, string)

Extensions.LoadFromXaml<TXaml>(TXaml, string)

Extensions.LoadFromXaml<TXaml>(TXaml, Type)

Extensions.LoadFromXamlFile<TXaml>(TXaml, string)