Interface IDataEditor
Represents a data editor.
Namespace: Umbraco.Core.PropertyEditors
Assembly: Umbraco.Core.dll
Syntax
public interface IDataEditor : IDiscoverableRemarks
This is the base interface for parameter and property editors.
Properties
View SourceAlias
Gets the alias of the editor.
Declaration
string Alias { get; }Property Value
| Type | Description |
|---|---|
| System.String |
DefaultConfiguration
Gets the configuration for the value editor.
Declaration
IDictionary<string, object> DefaultConfiguration { get; }Property Value
| Type | Description |
|---|---|
| System.Collections.Generic.IDictionary<System.String, System.Object> |
Group
Gets the group of the editor.
Declaration
string Group { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
Can be used to organize editors when presenting them.
Icon
Gets the icon of the editor.
Declaration
string Icon { get; }Property Value
| Type | Description |
|---|---|
| System.String |
Remarks
Can be used to display editors when presenting them.
IsDeprecated
Gets a value indicating whether the editor is deprecated.
Declaration
bool IsDeprecated { get; }Property Value
| Type | Description |
|---|---|
| System.Boolean |
Remarks
Deprecated editors are supported but not proposed in the UI.
Name
Gets the name of the editor.
Declaration
string Name { get; }Property Value
| Type | Description |
|---|---|
| System.String |
PropertyIndexValueFactory
Gets the index value factory for the editor.
Declaration
IPropertyIndexValueFactory PropertyIndexValueFactory { get; }Property Value
| Type | Description |
|---|---|
| IPropertyIndexValueFactory |
Type
Gets the type of the editor.
Declaration
EditorType Type { get; }Property Value
| Type | Description |
|---|---|
| EditorType |
Remarks
An editor can be a property value editor, or a parameter editor.
Methods
View SourceGetConfigurationEditor()
Gets an editor to edit the value editor configuration.
Declaration
IConfigurationEditor GetConfigurationEditor()Returns
| Type | Description |
|---|---|
| IConfigurationEditor |
Remarks
Is expected to throw if the editor does not support being configured, e.g. for most parameter editors.
GetValueEditor()
Gets a value editor.
Declaration
IDataValueEditor GetValueEditor()Returns
| Type | Description |
|---|---|
| IDataValueEditor |
GetValueEditor(Object)
Gets a configured value editor.
Declaration
IDataValueEditor GetValueEditor(object configuration)Parameters
| Type | Name | Description |
|---|---|---|
| System.Object | configuration |
Returns
| Type | Description |
|---|---|
| IDataValueEditor |