Rich Text Editor

Schema Alias: Umbraco.RichText

UI Alias: Umb.PropertyEditorUi.Tiptap

Returns: HTML

With the release of Umbraco 16, .

The Rich Text Editor property editor is highly configurable and based on . Depending on the configuration setup, it provides editors a lot of flexibility when working with content.

Customize everything from toolbar options to editor size to where pasted images are saved.

Define a cascading text formatting and style menu for the Rich Text Editor toolbar.

Use Blocks to define specific parts that can be added as part of the markup of the Rich Text Editor.

Extend the functionality of the Rich Text Editor with extensions.

Data Type Definition Example

Content Example

MVC View Example

With Models Builder

@{
    if (!string.IsNullOrEmpty(Model.RichText.ToString()))
    {
        <p>@Model.RichText</p>
    }
}

Without Models Builder

@{
    if (Model.HasValue("richText")){
        <p>@(Model.Value("richText"))</p>
    }
}

Add values programmatically

The example below demonstrates how to add values programmatically using a Razor view. However, this is used for illustrative purposes only and is not the recommended method for production environments.

@using Umbraco.Cms.Core.Services
@inject IContentService ContentService
@{
    // Create a variable for the GUID of the page you want to update
    var guid = Guid.Parse("32e60db4-1283-4caa-9645-f2153f9888ef");

    // Get the page using the GUID you've defined
    var content = ContentService.GetById(guid); // ID of your page

    // Create a variable for the desired value
    var htmlValue = new HtmlString("Add some text <strong>here</strong>");

    // Set the value of the property with alias 'richText'.
    content.SetValue("richText", htmlValue);

    // Save the change
    ContentService.Save(content);
}

Although the use of a GUID is preferable, you can also use the numeric ID to get the page:

@{
    // Get the page using it's id
    var content = ContentService.GetById(1234);
}

If Models Builder is enabled you can get the alias of the desired property without using a magic string.

@using Umbraco.Cms.Core.PublishedCache
@inject IPublishedContentTypeCache PublishedContentTypeCache
@{
    // Set the value of the property with alias 'richText'
    content.SetValue(Home.GetModelPropertyType(PublishedContentTypeCache, x => x.RichText).Alias, htmlValue);
}

PreviousDropdown NextConfiguration

Last updated 3 days ago

Was this helpful?

Add values programmatically

See the example below to see how a value can be added or changed programmatically. To update a value of a property editor you need the .

@using Umbraco.Cms.Core.Services
@inject IContentService ContentService
@{
    // Create a variable for the GUID of the page you want to update
    var guid = Guid.Parse("32e60db4-1283-4caa-9645-f2153f9888ef");

    // Get the page using the GUID you've defined
    var content = ContentService.GetById(guid); // ID of your page

    // Create a variable for the desired value
    var htmlValue = new HtmlString("Add some text <strong>here</strong>");

    // Set the value of the property with alias 'richText'.
    content.SetValue("richText", htmlValue);

    // Save the change
    ContentService.Save(content);
}

Although the use of a GUID is preferable, you can also use the numeric ID to get the page:

@{
    // Get the page using it's id
    var content = ContentService.GetById(1234);
}

If Models Builder is enabled you can get the alias of the desired property without using a magic string.

@using Umbraco.Cms.Core.PublishedCache
@inject IPublishedContentTypeCache PublishedContentTypeCache
@{
    // Set the value of the property with alias 'richText'
    content.SetValue(Home.GetModelPropertyType(PublishedContentTypeCache, x => x.RichText).Alias, htmlValue);
}