Struct Underline
Definition
- Assembly:
- Tizen.NUI.dll
A struct to pass data of Underline PropertyMap.
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 SourceColor
The color of the underline (if not provided then the color of the text is used).
Declaration
public Color Color { readonly get; set; }
Property Value
Type | Description |
---|---|
Color |
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().
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
public float? DashGap { readonly get; set; }
Property Value
Type | Description |
---|---|
float? |
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().
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
public float? DashWidth { readonly get; set; }
Property Value
Type | Description |
---|---|
float? |
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().
Enable
Whether the underline is enabled (the default value is false).
Declaration
public bool Enable { readonly get; set; }
Property Value
Type | Description |
---|---|
bool |
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().
Height
The height in pixels of the underline (if null, the default value is 1.0f).
Declaration
public float? Height { readonly get; set; }
Property Value
Type | Description |
---|---|
float? |
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().
Type
The type of the underline (the default type is Solid).
Declaration
public UnderlineType Type { readonly get; set; }
Property Value
Type | Description |
---|---|
UnderlineType |
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().
Methods
View SourceEquals(object)
Determines whether the specified object is equal to the current object.
Declaration
public override bool Equals(object obj)
Parameters
Type | Name | Description |
---|---|---|
object | obj | The object to compare with the current object. |
Returns
Type | Description |
---|---|
bool | true if equal Underline, else false. |
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().
Equals(Underline)
Determines whether the specified object is equal to the current object.
Declaration
public bool Equals(Underline other)
Parameters
Type | Name | Description |
---|---|---|
Underline | other | The Underline to compare with the current Underline. |
Returns
Type | Description |
---|---|
bool | true if equal Underline, else false. |
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().
GetHashCode()
Gets the hash code of this Underline.
Declaration
public override int GetHashCode()
Returns
Type | Description |
---|---|
int | The hash code. |
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().
Operators
View Sourceoperator ==(Underline, Underline)
The == operator.
Declaration
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 |
---|---|
bool | true if Underlines are equal |
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().
operator !=(Underline, Underline)
The != operator.
Declaration
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 |
---|---|
bool | true if Underlines are not equal |
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().