UnderlineStyle Class
Contains members that specify underline settings applied to text.
Declaration
public final class UnderlineStyle extends Struct<UnderlineStyle> implements IEquatable<UnderlineStyle>
Implements
Inherited Members
Inheritance
Constructors
UnderlineStyle() Constructor
Initializes a new instance of the UnderlineStyle class.
Declaration
public UnderlineStyle()
UnderlineStyle(OutlineStyle outline) Constructor
Initializes a new instance of the UnderlineStyle class with specified settings.
Declaration
public UnderlineStyle(OutlineStyle outline)
Parameters
| Name | Type | Description |
|---|---|---|
| outline | OutlineStyle | The outline style used to draw the underline. |
Fields
AUTOMATIC Field
Returns an underline style that uses automatic underline formatting.
Declaration
public static final UnderlineStyle AUTOMATIC
Field Value
| Type | Description |
|---|---|
UnderlineStyle |
An |
USE_TEXT_SETTINGS Field
Returns an underline style that uses text underline settings.
Declaration
public static final UnderlineStyle USE_TEXT_SETTINGS
Field Value
| Type | Description |
|---|---|
UnderlineStyle |
An |
Methods
equals(Object obj) Method
Determines whether the specified object is equal to the current object.
Declaration
public boolean equals(Object obj)
Parameters
| Name | Type | Description |
|---|---|---|
| obj | Object | The object to compare with this instance. |
Returns
| Type | Description |
|---|---|
| boolean |
|
equals(UnderlineStyle other) Method
Determines whether the specified object is equal to the current object.
Declaration
public boolean equals(UnderlineStyle other)
Parameters
| Name | Type | Description |
|---|---|---|
| other | UnderlineStyle |
The underline style to compare with the current instance. |
Returns
| Type | Description |
|---|---|
| boolean |
|
getOutline() Method
Gets the outline settings applied to text.
Declaration
public OutlineStyle getOutline()
Returns
| Type | Description |
|---|---|
| OutlineStyle | Outline settings applied to text. |
hashCode() Method
Returns the hash code for this object.
Declaration
public int hashCode()
Returns
| Type | Description |
|---|---|
| int | The hash code for this object. |