Struct Underline

Definition

Namespace:
Tizen.NUI.Text
Assembly:
Tizen.NUI.dll

A struct to pass data of Underline PropertyMap.

C#
Copy
public struct Underline : IEquatable<Underline>
Implements
IEquatable<Underline>
Remarks

The Underline struct is used as an argument to SetUnderline and GetUnderline methods.
See SetUnderline(Underline), GetUnderline(), SetUnderline(Underline), GetUnderline(), SetUnderline(Underline) and GetUnderline().

Properties

View Source

Color

The color of the underline (if not provided then the color of the text is used).

Declaration
C#
Copy
public Color Color { get; set; }
Property Value
Type Description
Color
View Source

DashGap

The gap between the dashes of the dashed underline (if null, the default value is 1.0f).
Only valid when "UnderlineType.Dashed" type is used.

Declaration
C#
Copy
public float? DashGap { get; set; }
Property Value
Type Description
Nullable<Single>
View Source

DashWidth

The width of the dashes of the dashed underline (if null, the default value is 2.0f).
Only valid when "UnderlineType.Dashed" type is used.

Declaration
C#
Copy
public float? DashWidth { get; set; }
Property Value
Type Description
Nullable<Single>
View Source

Enable

Whether the underline is enabled (the default value is false).

Declaration
C#
Copy
public bool Enable { get; set; }
Property Value
Type Description
Boolean
View Source

Height

The height in pixels of the underline (if null, the default value is 1.0f).

Declaration
C#
Copy
public float? Height { get; set; }
Property Value
Type Description
Nullable<Single>
View Source

Type

The type of the underline (the default type is Solid).

Declaration
C#
Copy
public UnderlineType Type { get; set; }
Property Value
Type Description
UnderlineType

Methods

View Source

Equals(Object)

Determines whether the specified object is equal to the current object.

Declaration
C#
Copy
public override bool Equals(object obj)
Parameters
Type Name Description
Object obj

The object to compare with the current object.

Returns
Type Description
Boolean

true if equal Underline, else false.

View Source

Equals(Underline)

Determines whether the specified object is equal to the current object.

Declaration
C#
Copy
public bool Equals(Underline other)
Parameters
Type Name Description
Underline other

The Underline to compare with the current Underline.

Returns
Type Description
Boolean

true if equal Underline, else false.

View Source

GetHashCode()

Gets the hash code of this Underline.

Declaration
C#
Copy
public override int GetHashCode()
Returns
Type Description
Int32

The hash code.

Operators

View Source

Equality(Underline, Underline)

The == operator.

Declaration
C#
Copy
public static bool operator ==(Underline lhsUnderline, Underline rhsUnderline)
Parameters
Type Name Description
Underline lhsUnderline

Underline to compare

Underline rhsUnderline

Underline to be compared

Returns
Type Description
Boolean

true if Underlines are equal

View Source

Inequality(Underline, Underline)

The != operator.

Declaration
C#
Copy
public static bool operator !=(Underline lhsUnderline, Underline rhsUnderline)
Parameters
Type Name Description
Underline lhsUnderline

Underline to compare

Underline rhsUnderline

Underline to be compared

Returns
Type Description
Boolean

true if Underlines are not equal

Implements

IEquatable<>

Extension Methods