# A2uiFormatStringFunction

Artifact: [androidx.a2ui:a2ui-model](https://developer.android.com/jetpack/androidx/releases/a2ui) [View Source](https://cs.android.com/search?q=file:androidx/a2ui/model/catalog/functions/A2uiFormatStringFunction.kt+class:androidx.a2ui.model.catalog.functions.A2uiFormatStringFunction) Added in [1.0.0-alpha02](https://developer.android.com/jetpack/androidx/releases/a2ui#1.0.0-alpha02)

*** ** * ** ***


```
class A2uiFormatStringFunction : A2uiFunction
```

<br />

*** ** * ** ***

Performs string interpolation of data model values and other functions.

Use this `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunction` to format strings with expressions.

## Summary

| ### Public companion properties |
|---|---|
| `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatStringFunction` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatStringFunction#INSTANCE()` |

| ### Public functions |
|---|---|
| `open https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatStringFunction#execute(kotlin.collections.Map,androidx.a2ui.model.protocol.A2uiExecutionContext)(args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>, executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext)` Interpolates the given string with bindings. |

| ### Public properties |
|---|---|
| `open https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/A2uiFunctionDefinition` | `https://developer.android.com/reference/kotlin/androidx/a2ui/model/catalog/functions/A2uiFormatStringFunction#definition()` The definition of the function. |

## Public companion properties

### INSTANCE

```
val INSTANCE: A2uiFormatStringFunction
```

## Public functions

### execute

```
open fun execute(args: Map<String, Any>, executionContext: A2uiExecutionContext): Any?
```

Interpolates the given string with bindings.

| Parameters |
|---|---|
| `args: https://kotlinlang.org/api/core/kotlin-stdlib/kotlin.collections/-map/index.html<https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-string/index.html, https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html>` | arguments containing the "value" string to format |
| `executionContext: https://developer.android.com/reference/kotlin/androidx/a2ui/model/protocol/A2uiExecutionContext` | context allowing to execute other functions, evaluate dynamic payloads and resolving data bindings |

| Returns |
|---|---|
| `https://kotlinlang.org/api/core/kotlin-stdlib/kotlin/-any/index.html?` | the formatted string |

## Public properties

### definition

```
open val definition: A2uiFunctionDefinition
```

The definition of the function.