Umbraco UI Builder
CMSCloudHeartcoreDXP
15.latest
15.latest
  • Umbraco UI Builder Documentation
  • Known Issues
  • Release Notes
  • Getting Started
    • First Steps with UI Builder
    • Requirements
    • Installing Umbraco UI Builder
    • Licensing
    • Configuration
    • User Interface
  • Upgrading
    • Upgrade your UI Builder setup
    • Upgrading Umbraco UI Builder
    • Version Specific Upgrade Notes
    • Migrate from Konstrukt to Umbraco UI Builder
  • How-to Guides
    • Creating your First Integration
  • Areas
    • Explore Areas in UI Builder
    • Sections
      • Summary Dashboards
    • Trees
      • Folders
    • Dashboards
    • Context Apps
  • Collections
    • Work with Collections in UI Builder
    • The Basics
    • List Views
      • Field Views
    • Editors
    • Child Collections
      • Child Collection Groups
      • Retrieve Child Collections
    • Related Collections
    • Entity Identifier Converters
  • Searching
    • Add Search to Your Collections
    • Searchable Properties
  • Filtering
    • Filter Your Data with Ease
    • Global Filters
    • Data Views
      • Data Views Builders
    • Filterable Properties
  • Actions
    • Trigger Actions in UI Builder
    • The Basics
    • Action Visibility
    • Inbuilt Actions
  • Cards
    • Display Insights with Cards
    • Count Cards
    • Custom Cards
  • Property Editors
    • Enhance Input with Property Editors
    • Entity Picker
  • Advanced
    • Ready to go deeper?
    • Virtual Sub Trees
    • Encrypted Properties
    • Value Mappers
    • Repositories
    • Events
  • Miscellaneous
    • Conventions
    • Umbraco Aliases
Powered by GitBook
On this page
  • Defining a Value Mapper
  • Example
  • Setting a Field Value Mapper
  • Using the SetValueMapper() Method
  • Using the SetValueMapper(Type mapperType) Method
  • Using the SetValueMapper(Mapper mapper) Method

Was this helpful?

Edit on GitHub
Export as PDF
  1. Advanced

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

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

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

Example

fieldConfig.SetValueMapper<MyValueMapper>();

Using the SetValueMapper(Type mapperType) Method

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

Method Syntax

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

Example

fieldConfig.SetValueMapper(typeof(MyValueMapper));

Using the SetValueMapper(Mapper mapper) Method

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

Method Syntax

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

Example

fieldConfig.SetValueMapper(new MyValueMapper());
PreviousEncrypted PropertiesNextRepositories

Last updated 1 month ago

Was this helpful?