View Source

Class ColorPickerPropertyEditor

Represents a color picker property editor.

Inheritance

object

DataEditor

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

[DataEditor("Umbraco.ColorPicker", ValueEditorIsReusable = true)]
public class ColorPickerPropertyEditor : DataEditor, IDataEditor, IDiscoverable, IValueSchemaProvider

Constructors

ColorPickerPropertyEditor(IDataValueEditorFactory, IIOHelper, IConfigurationEditorJsonSerializer)

Initializes a new instance of the ColorPickerPropertyEditor class.

Declaration

public ColorPickerPropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)

Parameters

Type	Name	Description
IDataValueEditorFactory	dataValueEditorFactory
IIOHelper	ioHelper
IConfigurationEditorJsonSerializer	configurationEditorJsonSerializer

Properties

PropertyIndexValueFactory

Gets the index value factory for the editor.

Declaration

public override IPropertyIndexValueFactory PropertyIndexValueFactory { get; }

Property Value

Type	Description
IPropertyIndexValueFactory

Methods

CreateConfigurationEditor()

Creates a configuration editor instance.

Declaration

protected override IConfigurationEditor CreateConfigurationEditor()

Returns

Type	Description
IConfigurationEditor

CreateValueEditor()

Creates a value editor instance.

Declaration

protected override IDataValueEditor CreateValueEditor()

Returns

Type	Description
IDataValueEditor

GetValueSchema(object?)

Gets a JSON Schema (draft 2020-12) describing the incoming value structure.

Declaration

public JsonObject? GetValueSchema(object? configuration)

Parameters

Type	Name	Description
object	configuration	The data type configuration, which may affect the schema.

Returns

Type	Description
JsonObject	A System.Text.Json.Nodes.JsonObject containing a valid JSON Schema, or null if the schema cannot be generated for the given configuration.

Remarks

The returned schema should describe the structure that IDataValueEditor.FromEditor receives (i.e., what the Management API accepts).

For configuration-dependent schemas (e.g., BlockList with specific element types), the schema should reflect the constraints defined in the configuration.

GetValueType(object?)

Gets the CLR type that represents the incoming value structure.

Declaration

public Type? GetValueType(object? configuration)

Parameters

Type	Name	Description
object	configuration	The data type configuration, which may affect the value type.

Returns

Type	Description
Type	The CLR type of the incoming value, or null if the type cannot be determined or varies significantly based on configuration.

Remarks

For simple editors (e.g., textbox), this might return string. For complex editors (e.g., MediaPicker3), this returns the DTO type that the editor submits. For block-based editors where the structure is entirely configuration-dependent, this may return null.