View Source

Class RichTextPropertyEditor

Represents a rich text property editor.

Inheritance

object

DataEditor

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

[DataEditor("Umbraco.RichText", ValueType = "TEXT", ValueEditorIsReusable = true)]
public class RichTextPropertyEditor : DataEditor, IDataEditor, IDiscoverable

Constructors

RichTextPropertyEditor(IDataValueEditorFactory, IIOHelper, IRichTextPropertyIndexValueFactory)

Initializes a new instance of the RichTextPropertyEditor class.

Declaration

public RichTextPropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IRichTextPropertyIndexValueFactory richTextPropertyIndexValueFactory)

Parameters

Type	Name	Description
IDataValueEditorFactory	dataValueEditorFactory
IIOHelper	ioHelper
IRichTextPropertyIndexValueFactory	richTextPropertyIndexValueFactory

Remarks

The constructor will setup the property editor based on the attribute if one is found.

Properties

PropertyIndexValueFactory

Gets the index value factory for the editor.

Declaration

public override IPropertyIndexValueFactory PropertyIndexValueFactory { get; }

Property Value

Type	Description
IPropertyIndexValueFactory

SupportsConfigurableElements

Gets a value indicating whether the data editor supports configurable elements.

Declaration

public override bool SupportsConfigurableElements { get; }

Property Value

Type	Description
bool

Remarks

Adding a virtual method that wraps the default implementation allows derived classes to override the default implementation without having to explicitly inherit the interface.

Methods

CanMergePartialPropertyValues(IPropertyType)

Determines if the value editor needs to perform MergePartialPropertyValueForCulture(object?, object?, string?) for a given property type.

Declaration

public override bool CanMergePartialPropertyValues(IPropertyType propertyType)

Parameters

Type	Name	Description
IPropertyType	propertyType

Returns

Type	Description
bool

CreateConfigurationEditor()

Creates a configuration editor instance.

Declaration

protected override IConfigurationEditor CreateConfigurationEditor()

Returns

Type	Description
IConfigurationEditor

CreateValueEditor()

Create a custom value editor

Declaration

protected override IDataValueEditor CreateValueEditor()

Returns

Type	Description
IDataValueEditor

MergePartialPropertyValueForCulture(object?, object?, string?)

Partially merges a source property value into a target property value for a given culture.

Declaration

public override object? MergePartialPropertyValueForCulture(object? sourceValue, object? targetValue, string? culture)

Parameters

Type	Name	Description
object	sourceValue	The source property value.
object	targetValue	The target property value.
string	culture	The culture (or null for invariant).

Returns

Type	Description
object	The result of the merge operation.

MergeVariantInvariantPropertyValue(object?, object?, bool, HashSet<string>)

Merges variant and invariant property values.

Declaration

public override object? MergeVariantInvariantPropertyValue(object? sourceValue, object? targetValue, bool canUpdateInvariantData, HashSet<string> allowedCultures)

Parameters

Type	Name	Description
object	sourceValue	The source property value.
object	targetValue	The target property value.
bool	canUpdateInvariantData	A value indicating whether invariant data can be updated.
HashSet<string>	allowedCultures	The set of allowed cultures.

Returns

Type	Description
object	The result of the merge operation.