View Source

Class PlainJsonPropertyEditor

Represents a property editor for configuration-less JSON properties.

Inheritance
object
DataEditor
Namespace: Umbraco.Cms.Core.PropertyEditors
Assembly: Umbraco.Core.dll
Syntax
[DataEditor("Umbraco.Plain.Json", ValueEditorIsReusable = true, ValueType = "JSON")]
public class PlainJsonPropertyEditor : DataEditor, IDataEditor, IDiscoverable, IValueSchemaProvider

Constructors

View Source

PlainJsonPropertyEditor(IDataValueEditorFactory)

Initializes a new instance of the PlainJsonPropertyEditor class.

Declaration
public PlainJsonPropertyEditor(IDataValueEditorFactory dataValueEditorFactory)
Parameters
Type Name Description
IDataValueEditorFactory dataValueEditorFactory

Methods

View Source

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.

View Source

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.