View Source

Class PropertyEditorCollection

Represents a collection of property editors (IDataEditor).

Inheritance

object

BuilderCollectionBase<IDataEditor>

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Core.dll

Syntax

public class PropertyEditorCollection : BuilderCollectionBase<IDataEditor>, IBuilderCollection<IDataEditor>

Constructors

PropertyEditorCollection(DataEditorCollection)

Initializes a new instance of the PropertyEditorCollection class.

Declaration

public PropertyEditorCollection(DataEditorCollection dataEditors)

Parameters

Type	Name	Description
DataEditorCollection	dataEditors	The data editor collection.

Properties

this[string?]

Gets the property editor with the specified alias.

Declaration

public virtual IDataEditor? this[string? alias] { get; }

Parameters

Type	Name	Description
string	alias	The editor alias.

Property Value

Type	Description
IDataEditor	The property editor if found; otherwise, null.

Remarks

Virtual so it can be mocked.

Methods

TryGet(string?, out IDataEditor)

Tries to get the property editor with the specified alias.

Declaration

public virtual bool TryGet(string? alias, out IDataEditor editor)

Parameters

Type	Name	Description
string	alias	The editor alias.
IDataEditor	editor	When this method returns, contains the editor if found; otherwise, null.

Returns

Type	Description
bool	true if the editor was found; otherwise, false.