> For the complete documentation index, see [llms.txt](https://docs.umbraco.com/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://docs.umbraco.com/umbraco-ui-builder/17.latest/advanced/value-mappers.md).

# Value Mappers

Configuring value mappers in Umbraco UI Builder to modify how data is stored and retrieved.

Value mappers in Umbraco UI Builder act as intermediaries between the editor UI and the database, allowing customization of stored field values. By default, Umbraco UI Builder saves data as it would be stored in Umbraco, but value mappers enable modifications.

When resolving a value mapper, Umbraco UI Builder first checks the global DI container. If no type is defined, it manually instantiates a new instance.

## Defining a Value Mapper

To define a mapper, create a class that inherits from the base class `ValueMapper` and implements the `EditorToModel` and `ModelToEditor` methods.

### Example

```csharp
public class MyValueMapper : ValueMapper
{
    public override object EditorToModel(object input)
    {
        // Tweak the input and return mapped object
        ...
    }

    public override object ModelToEditor(object input)
    {
        // Tweak the input and return mapped object
        ...
    }    
}
```

## Setting a Field Value Mapper

Value mappers are defined as part of a collection editor field configuration.

### Using the `SetValueMapper()` Method

Set the value mapper for the current field.

#### Method Syntax

```csharp
SetValueMapper<TMapperType>() : EditorFieldConfigBuilder<TEntityType, TValueType>
```

#### Example

```csharp
fieldConfig.SetValueMapper<MyValueMapper>();
```

### Using the `SetValueMapper(Type mapperType)` Method

Set the value mapper for the current field using a type reference.

#### Method Syntax

```csharp
SetValueMapper(Type mapperType) : EditorFieldConfigBuilder<TEntityType, TValueType>
```

#### Example

```csharp
fieldConfig.SetValueMapper(typeof(MyValueMapper));
```

### Using the `SetValueMapper(Mapper mapper)` Method

Set the value mapper for the current field using an instance.

#### Method Syntax

```csharp
SetValueMapper(Mapper mapper) : EditorFieldConfigBuilder<TEntityType, TValueType>
```

#### Example

```csharp
fieldConfig.SetValueMapper(new MyValueMapper());
```


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://docs.umbraco.com/umbraco-ui-builder/17.latest/advanced/value-mappers.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.