Search Results for

    Show / Hide Table of Contents
    View Source

    Class DropDownFlexiblePropertyEditor

    Represents a flexible drop-down property editor used in Umbraco for selecting values from a configurable list. This editor allows for dynamic configuration of options and supports various selection scenarios.

    Inheritance
    object
    DataEditor
    Namespace: Umbraco.Cms.Core.PropertyEditors
    Assembly: Umbraco.Infrastructure.dll
    Syntax
    [DataEditor("Umbraco.DropDown.Flexible", ValueEditorIsReusable = true)]
    public class DropDownFlexiblePropertyEditor : DataEditor, IDataEditor, IDiscoverable, IValueSchemaProvider

    Constructors

    View Source

    DropDownFlexiblePropertyEditor(IDataValueEditorFactory, IIOHelper, IConfigurationEditorJsonSerializer)

    Initializes a new instance of the DropDownFlexiblePropertyEditor class.

    Declaration
    public DropDownFlexiblePropertyEditor(IDataValueEditorFactory dataValueEditorFactory, IIOHelper ioHelper, IConfigurationEditorJsonSerializer configurationEditorJsonSerializer)
    Parameters
    Type Name Description
    IDataValueEditorFactory dataValueEditorFactory

    Factory used to create data value editors for property values.

    IIOHelper ioHelper

    Helper for IO operations, such as file and path handling.

    IConfigurationEditorJsonSerializer configurationEditorJsonSerializer

    Serializer for handling JSON configuration of the editor.

    Methods

    View Source

    CreateConfigurationEditor()

    Creates a configuration editor instance.

    Declaration
    protected override IConfigurationEditor CreateConfigurationEditor()
    Returns
    Type Description
    IConfigurationEditor
    View Source

    CreateValueEditor()

    Creates a value editor instance.

    Declaration
    protected override IDataValueEditor CreateValueEditor()
    Returns
    Type Description
    IDataValueEditor
    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.

    • View Source
    In this article
    Back to top Copyright © 2016-present Umbraco
    Generated by DocFX