# androidx.core.text

*** ** * ** ***

## Interfaces

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/TextDirectionHeuristicCompat` | Interface for objects that use a heuristic for guessing at the paragraph direction by examining text. |

## Classes

|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter` | Utility class for formatting text for display in a potentially opposite-directionality context without garbling. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/BidiFormatter.Builder` | A class for building a BidiFormatter with non-default options. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/HtmlCompat` | Backwards compatible version of `https://developer.android.com/reference/android/text/Html.html`. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/ICUCompat` |   |
| `https://developer.android.com/reference/kotlin/androidx/core/text/PrecomputedTextCompat` | A text which has the character metrics data. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/PrecomputedTextCompat.Params` | The information required for building `https://developer.android.com/reference/kotlin/androidx/core/text/PrecomputedTextCompat`. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/PrecomputedTextCompat.Params.Builder` | A builder for creating `https://developer.android.com/reference/kotlin/androidx/core/text/PrecomputedTextCompat.Params`. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/TextDirectionHeuristicsCompat` | Some objects that implement TextDirectionHeuristic. |
| `https://developer.android.com/reference/kotlin/androidx/core/text/TextUtilsCompat` | Backwards compatible version of `https://developer.android.com/reference/android/text/TextUtils.html`. |

## Top-level functions summary

|---|---|
| `inline https://developer.android.com/reference/android/text/SpannedString.html` | `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#buildSpannedString(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Builds new string by populating a newly created `https://developer.android.com/reference/android/text/SpannableStringBuilder.html` using the provided `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#buildSpannedString(kotlin.Function1)` and then converting it to `https://developer.android.com/reference/android/text/SpannedString.html`. |

## Extension functions summary

|---|---|
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).backgroundColor(kotlin.Int,kotlin.Function1)( color: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).backgroundColor(kotlin.Int,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/BackgroundColorSpan.html`. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).bold(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).bold(kotlin.Function1)` in a bold `https://developer.android.com/reference/android/text/style/StyleSpan.html`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/android/text/Spannable.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).clearSpans()()` Clear all spans from this text. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).color(kotlin.Int,kotlin.Function1)( color: @https://developer.android.com/reference/kotlin/androidx/annotation/ColorInt https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).color(kotlin.Int,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/ForegroundColorSpan.html`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-array/index.html<T>` | `<T : https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html> https://developer.android.com/reference/android/text/Spanned.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spanned).getSpans(kotlin.Int,kotlin.Int)(start: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, end: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Get all spans that are instance of `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spanned).getSpans(kotlin.Int,kotlin.Int)`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.String).htmlEncode()()` Html-encode the string. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Any,kotlin.Function1)(span: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html, builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Any,kotlin.Function1)` in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Any,kotlin.Function1)`. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)( vararg spans: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html, builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-boolean/index.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.CharSequence).isDigitsOnly()()` Returns whether the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` contains only digits. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).italic(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).italic(kotlin.Function1)` in an italic `https://developer.android.com/reference/android/text/style/StyleSpan.html`. |
| `inline https://developer.android.com/reference/android/text/Spanned.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.String).parseAsHtml(kotlin.Int,android.text.Html.ImageGetter,android.text.Html.TagHandler)( flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, imageGetter: https://developer.android.com/reference/android/text/Html.ImageGetter.html?, tagHandler: https://developer.android.com/reference/android/text/Html.TagHandler.html? )` Returns a `https://developer.android.com/reference/android/text/Spanned.html` from parsing this string as HTML. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).scale(kotlin.Float,kotlin.Function1)( proportion: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-float/index.html, builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html )` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).scale(kotlin.Float,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/RelativeSizeSpan.html`. |
| `inline operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/android/text/Spannable.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.ranges.IntRange,kotlin.Any)(range: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.ranges/-int-range/index.html, span: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)` Add `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.ranges.IntRange,kotlin.Any)` to the `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.ranges.IntRange,kotlin.Any)` of the text. |
| `inline operator https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html` | `https://developer.android.com/reference/android/text/Spannable.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)(start: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, end: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html, span: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html)` Add `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)` to the range `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)`...`https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)` of the text. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).strikeThrough(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).strikeThrough(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/StrikethroughSpan.html`. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).subscript(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).subscript(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/SubscriptSpan.html`. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).superscript(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).superscript(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/SuperscriptSpan.html`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html` | `https://developer.android.com/reference/android/text/Spanned.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spanned).toHtml(kotlin.Int)(option: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html)` Returns a string of HTML from the spans in this `https://developer.android.com/reference/android/text/Spanned.html`. |
| `inline https://developer.android.com/reference/android/text/Spannable.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.CharSequence).toSpannable()()` Returns a new `https://developer.android.com/reference/android/text/Spannable.html` from `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html`, or the source itself if it is already an instance of `https://developer.android.com/reference/android/text/SpannableString.html`. |
| `inline https://developer.android.com/reference/android/text/Spanned.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.CharSequence).toSpanned()()` Returns a new `https://developer.android.com/reference/android/text/Spanned.html` from `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html`, or the source itself if it is already an instance of `https://developer.android.com/reference/android/text/SpannedString.html`. |
| `inline https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(kotlin.CharSequence).trimmedLength()()` Returns the length that the specified `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` would have if spaces and ASCII control characters were trimmed from the start and end, as by `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.text/index.html`. |
| `inline https://developer.android.com/reference/android/text/SpannableStringBuilder.html` | `https://developer.android.com/reference/android/text/SpannableStringBuilder.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).underline(kotlin.Function1)(builderAction: https://developer.android.com/reference/android/text/SpannableStringBuilder.html.() -> https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-unit/index.html)` Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).underline(kotlin.Function1)` in an `https://developer.android.com/reference/android/text/style/UnderlineSpan.html`. |

## Extension properties summary

|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html` | `https://developer.android.com/reference/java/util/Locale.html.https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(java.util.Locale).layoutDirection()` Returns layout direction for a given locale. |

## Top-level functions

### buildSpannedString

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:buildSpannedString) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun buildSpannedString(builderAction: SpannableStringBuilder.() -> Unit): SpannedString
```

Builds new string by populating a newly created `https://developer.android.com/reference/android/text/SpannableStringBuilder.html` using the provided `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#buildSpannedString(kotlin.Function1)` and then converting it to `https://developer.android.com/reference/android/text/SpannedString.html`.

## Extension functions

### SpannableStringBuilder.backgroundColor

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:backgroundColor) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.backgroundColor(
    color: @ColorInt Int,
    builderAction: SpannableStringBuilder.() -> Unit
): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).backgroundColor(kotlin.Int,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/BackgroundColorSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### SpannableStringBuilder.bold

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:bold) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.bold(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).bold(kotlin.Function1)` in a bold `https://developer.android.com/reference/android/text/style/StyleSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### Spannable.clearSpans

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableString.kt+function:clearSpans) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun Spannable.clearSpans(): Unit
```

Clear all spans from this text.

### SpannableStringBuilder.color

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:color) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.color(
    color: @ColorInt Int,
    builderAction: SpannableStringBuilder.() -> Unit
): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).color(kotlin.Int,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/ForegroundColorSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### Spanned.getSpans

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannedString.kt+function:getSpans)

```
inline fun <T : Any> Spanned.getSpans(start: Int = 0, end: Int = length): Array<T>
```

Get all spans that are instance of `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spanned).getSpans(kotlin.Int,kotlin.Int)`.

### String.htmlEncode

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/String.kt+function:htmlEncode) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun String.htmlEncode(): String
```

Html-encode the string.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/TextUtils.html#htmlEncode(java.lang.String)` |   |

### SpannableStringBuilder.inSpans

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:inSpans) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.inSpans(span: Any, builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Any,kotlin.Function1)` in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Any,kotlin.Function1)`.

Note: the span will only have the correct position if the `builderAction` only appends or replaces text. Inserting, deleting, or clearing the text will cause the span to be placed at an incorrect position.

### SpannableStringBuilder.inSpans

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:inSpans)

```
inline fun SpannableStringBuilder.inSpans(
    vararg spans: Any,
    builderAction: SpannableStringBuilder.() -> Unit
): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)`.

Note: the spans will only have the correct position if the `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` only appends or replaces text. Inserting, deleting, or clearing the text will cause the span to be placed at an incorrect position.

### CharSequence.isDigitsOnly

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/CharSequence.kt+function:isDigitsOnly) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun CharSequence.isDigitsOnly(): Boolean
```

Returns whether the given `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` contains only digits.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/TextUtils.html#isDigitsOnly(java.lang.CharSequence)` |   |

### SpannableStringBuilder.italic

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:italic) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.italic(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).italic(kotlin.Function1)` in an italic `https://developer.android.com/reference/android/text/style/StyleSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### String.parseAsHtml

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/Html.kt+function:parseAsHtml) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun String.parseAsHtml(
    flags: Int = FROM_HTML_MODE_LEGACY,
    imageGetter: Html.ImageGetter? = null,
    tagHandler: Html.TagHandler? = null
): Spanned
```

Returns a `https://developer.android.com/reference/android/text/Spanned.html` from parsing this string as HTML.

| Parameters |
|---|---|
| `flags: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-int/index.html = FROM_HTML_MODE_LEGACY` | Additional option to set the behavior of the HTML parsing. Default is set to `https://developer.android.com/reference/android/text/Html.html#FROM_HTML_MODE_LEGACY` which was introduced in API 24. |
| `imageGetter: https://developer.android.com/reference/android/text/Html.ImageGetter.html? = null` | Returns displayable styled text from the provided HTML string. |
| `tagHandler: https://developer.android.com/reference/android/text/Html.TagHandler.html? = null` | Notified when HTML tags are encountered a tag the parser does not know how to interpret. |

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/Html.html#fromHtml(java.lang.String)` |   |

### SpannableStringBuilder.scale

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:scale) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.scale(
    proportion: Float,
    builderAction: SpannableStringBuilder.() -> Unit
): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).scale(kotlin.Float,kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/RelativeSizeSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### Spannable.set

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableString.kt+function:set) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline operator fun Spannable.set(range: IntRange, span: Any): Unit
```

Add `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.ranges.IntRange,kotlin.Any)` to the `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.ranges.IntRange,kotlin.Any)` of the text.

```kotlin
val s = "Hello, World!".toSpannable()
s[0..5] = UnderlineSpan()
```

Note: The range end value is exclusive.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/Spannable.html#setSpan(java.lang.Object, int, int, int)` |   |

### Spannable.set

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableString.kt+function:set) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline operator fun Spannable.set(start: Int, end: Int, span: Any): Unit
```

Add `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)` to the range `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)`...`https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)` of the text.

```kotlin
val s = "Hello, World!".toSpannable()
s[0, 5] = UnderlineSpan()
```

Note: The `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.Spannable).set(kotlin.Int,kotlin.Int,kotlin.Any)` value is exclusive.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/Spannable.html#setSpan(java.lang.Object, int, int, int)` |   |

### SpannableStringBuilder.strikeThrough

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:strikeThrough) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.strikeThrough(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).strikeThrough(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/StrikethroughSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### SpannableStringBuilder.subscript

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:subscript) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.subscript(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).subscript(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/SubscriptSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### SpannableStringBuilder.superscript

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:superscript) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.superscript(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).superscript(kotlin.Function1)` in a `https://developer.android.com/reference/android/text/style/SuperscriptSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

### Spanned.toHtml

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/Html.kt+function:toHtml) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun Spanned.toHtml(option: Int = TO_HTML_PARAGRAPH_LINES_CONSECUTIVE): String
```

Returns a string of HTML from the spans in this `https://developer.android.com/reference/android/text/Spanned.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/Html.html#toHtml(android.text.Spanned)` |   |

### CharSequence.toSpannable

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableString.kt+function:toSpannable) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun CharSequence.toSpannable(): Spannable
```

Returns a new `https://developer.android.com/reference/android/text/Spannable.html` from `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html`, or the source itself if it is already an instance of `https://developer.android.com/reference/android/text/SpannableString.html`.

### CharSequence.toSpanned

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannedString.kt+function:toSpanned) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun CharSequence.toSpanned(): Spanned
```

Returns a new `https://developer.android.com/reference/android/text/Spanned.html` from `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html`, or the source itself if it is already an instance of `https://developer.android.com/reference/android/text/SpannedString.html`.

### CharSequence.trimmedLength

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/CharSequence.kt+function:trimmedLength) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun CharSequence.trimmedLength(): Int
```

Returns the length that the specified `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-char-sequence/index.html` would have if spaces and ASCII control characters were trimmed from the start and end, as by `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.text/index.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/TextUtils.html#getTrimmedLength(java.lang.CharSequence)` |   |

### SpannableStringBuilder.underline

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/SpannableStringBuilder.kt+function:underline) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
inline fun SpannableStringBuilder.underline(builderAction: SpannableStringBuilder.() -> Unit): SpannableStringBuilder
```

Wrap appended text in `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).underline(kotlin.Function1)` in an `https://developer.android.com/reference/android/text/style/UnderlineSpan.html`.

| See also |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/core/text/package-summary#(android.text.SpannableStringBuilder).inSpans(kotlin.Array,kotlin.Function1)` |   |

## Extension properties

### Locale.layoutDirection

Artifact: [androidx.core:core](https://developer.android.com/jetpack/androidx/releases/core) [View Source](https://cs.android.com/search?q=file:androidx/core/text/Locale.kt+symbol:layoutDirection) Added in [1.1.0](https://developer.android.com/jetpack/androidx/releases/core#1.1.0)

```
val Locale.layoutDirection: Int
```

Returns layout direction for a given locale.

| See also |
|---|---|
| `https://developer.android.com/reference/android/text/TextUtils.html#getLayoutDirectionFromLocale(java.util.Locale)` |   |