Added in API level 1

UnderlineSpan

---

Kotlin |Java

open class UnderlineSpan : CharacterStyle, ParcelableSpan, UpdateAppearance

kotlin.Any
↳	android.text.style.CharacterStyle
	↳	android.text.style.UnderlineSpan

A span that underlines the text it's attached to.

The span can be used like this:

<code>SpannableString string = new SpannableString("Text with underline span");
 string.setSpan(new UnderlineSpan(), 10, 19, Spanned.SPAN_EXCLUSIVE_EXCLUSIVE);</code>

Underlined text.

Summary

Public constructors
UnderlineSpan() Creates an UnderlineSpan.
UnderlineSpan(src: Parcel) Creates an UnderlineSpan from a parcel.

Public methods
open Int	describeContents()
open Int	getSpanTypeId()
open String	toString()
open Unit	updateDrawState(ds: TextPaint)
open Unit	writeToParcel(dest: Parcel, flags: Int) Flatten this object in to a Parcel.

Inherited functions

From class CharacterStyle CharacterStyle! getUnderlying() Returns "this" for most CharacterStyles, but for CharacterStyles that were generated by wrap, returns the underlying CharacterStyle. CharacterStyle! wrap(cs: CharacterStyle!) A given CharacterStyle can only applied to a single region of a given Spanned. If you need to attach the same CharacterStyle to multiple regions, you can use this method to wrap it with a new object that will have the same effect but be a distinct object so that it can also be attached without conflict.

Public constructors

UnderlineSpan

Added in API level 1

UnderlineSpan()

Creates an UnderlineSpan.

UnderlineSpan

Added in API level 3

UnderlineSpan(src: Parcel)

Creates an UnderlineSpan from a parcel.

Parameters
src	Parcel: This value cannot be null.

Public methods

describeContents

Added in API level 3

open fun describeContents(): Int

Return
Int	a bitmask indicating the set of special object types marshaled by this Parcelable object instance. Value is either 0 or android.os.Parcelable#CONTENTS_FILE_DESCRIPTOR

getSpanTypeId

Added in API level 3

open fun getSpanTypeId(): Int

toString

Added in API level 1

open fun toString(): String

Return
String	a string representation of the object.

updateDrawState

Added in API level 1

open fun updateDrawState(ds: TextPaint): Unit

Parameters
ds	TextPaint: This value cannot be null.

writeToParcel

Added in API level 3

open fun writeToParcel(
    dest: Parcel, 
    flags: Int
): Unit

Flatten this object in to a Parcel.

Parameters
dest	Parcel: This value cannot be null.
flags	Int: Additional flags about how the object should be written. May be 0 or PARCELABLE_WRITE_RETURN_VALUE. Value is either 0 or a combination of android.os.Parcelable#PARCELABLE_WRITE_RETURN_VALUE, and android.os.Parcelable.PARCELABLE_ELIDE_DUPLICATES