View Source

Class DateTimePropertyEditorBase

Provides base functionality for date time property editors that store their value as a JSON string with timezone information.

Inheritance

object

DataEditor

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class DateTimePropertyEditorBase : DataEditor, IDataEditor, IDiscoverable, IValueSchemaProvider

Constructors

DateTimePropertyEditorBase(IDataValueEditorFactory, IIOHelper, IPropertyIndexValueFactory)

Initializes a new instance of the DateTimePropertyEditorBase class.

Declaration

protected DateTimePropertyEditorBase(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IPropertyIndexValueFactory propertyIndexValueFactory)

Parameters

Type	Name	Description
IDataValueEditorFactory	dataValueEditorFactory
IIOHelper	ioHelper
IPropertyIndexValueFactory	propertyIndexValueFactory

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.

MapDateToEditorFormat(DateTimeDto)

Converts the specified date and time value to a string formatted for use in the property editor.

Declaration

protected abstract string MapDateToEditorFormat(DateTimeValueConverterBase.DateTimeDto dateTimeDto)

Parameters

Type	Name	Description
DateTimeValueConverterBase.DateTimeDto	dateTimeDto	An object containing the date and time components to be formatted.

Returns

Type	Description
string	A string representation of the date and time, formatted for use in the property editor.