View Source

Class MultiUrlPickerValueEditor

Inheritance

object

DataValueEditor

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

public class MultiUrlPickerValueEditor : DataValueEditor, IDataValueEditor, IDataValueReference, ICacheReferencedEntities

Constructors

MultiUrlPickerValueEditor(ILogger<MultiUrlPickerValueEditor>, ILocalizedTextService, IShortStringHelper, DataEditorAttribute, IPublishedUrlProvider, IJsonSerializer, IIOHelper, IContentService, IMediaService)

Declaration

[Obsolete("Please use the constructor taking all parameters. Scheduled for removal in Umbraco 19.")]
public MultiUrlPickerValueEditor(ILogger<MultiUrlPickerValueEditor> logger, ILocalizedTextService localizedTextService, IShortStringHelper shortStringHelper, DataEditorAttribute attribute, IPublishedUrlProvider publishedUrlProvider, IJsonSerializer jsonSerializer, IIOHelper ioHelper, IContentService contentService, IMediaService mediaService)

Parameters

Type	Name	Description
ILogger<MultiUrlPickerValueEditor>	logger
ILocalizedTextService	localizedTextService
IShortStringHelper	shortStringHelper
DataEditorAttribute	attribute
IPublishedUrlProvider	publishedUrlProvider
IJsonSerializer	jsonSerializer
IIOHelper	ioHelper
IContentService	contentService
IMediaService	mediaService

MultiUrlPickerValueEditor(ILogger<MultiUrlPickerValueEditor>, ILocalizedTextService, IShortStringHelper, DataEditorAttribute, IPublishedUrlProvider, IJsonSerializer, IIOHelper, IContentService, IMediaService, AppCaches)

Declaration

public MultiUrlPickerValueEditor(ILogger<MultiUrlPickerValueEditor> logger, ILocalizedTextService localizedTextService, IShortStringHelper shortStringHelper, DataEditorAttribute attribute, IPublishedUrlProvider publishedUrlProvider, IJsonSerializer jsonSerializer, IIOHelper ioHelper, IContentService contentService, IMediaService mediaService, AppCaches appCaches)

Parameters

Type	Name	Description
ILogger<MultiUrlPickerValueEditor>	logger
ILocalizedTextService	localizedTextService
IShortStringHelper	shortStringHelper
DataEditorAttribute	attribute
IPublishedUrlProvider	publishedUrlProvider
IJsonSerializer	jsonSerializer
IIOHelper	ioHelper
IContentService	contentService
IMediaService	mediaService
AppCaches	appCaches

Methods

CacheReferencedEntities(IEnumerable<object>)

Caches the entities referenced by the provided block data values.

Declaration

public void CacheReferencedEntities(IEnumerable<object> values)

Parameters

Type	Name	Description
IEnumerable<object>	values	An enumerable collection of block values that may contain the entities to be cached.

FromEditor(ContentPropertyData, object?)

A method to deserialize the string value that has been saved in the content editor to an object to be stored in the database.

Declaration

public override object? FromEditor(ContentPropertyData editorValue, object? currentValue)

Parameters

Type	Name	Description
ContentPropertyData	editorValue	The value returned by the editor.
object	currentValue	The current value that has been persisted to the database for this editor. This value may be useful for how the value then get's deserialized again to be re-persisted. In most cases it will probably not be used.

Returns

Type	Description
object	The value that gets persisted to the database.

Remarks

By default this will attempt to automatically convert the string value to the value type supplied by ValueType. If overridden then the object returned must match the type supplied in the ValueType, otherwise persisting the value to the DB will fail when it tries to validate the value type.

GetReferences(object?)

Returns any references contained in the value

Declaration

public IEnumerable<UmbracoEntityReference> GetReferences(object? value)

Parameters

Type	Name	Description
object	value

Returns

Type	Description
IEnumerable<UmbracoEntityReference>

ToEditor(IProperty, string?, string?)

A method used to format the database value to a value that can be used by the editor.

Declaration

public override object? ToEditor(IProperty property, string? culture = null, string? segment = null)

Parameters

Type	Name	Description
IProperty	property	The property.
string	culture	The culture.
string	segment	The segment.

Returns

Type	Description
object

Remarks

The object returned will automatically be serialized into JSON notation. For most property editors the value returned is probably just a string, but in some cases a JSON structure will be returned.

Exceptions

Type	Condition
ArgumentOutOfRangeException	ValueType was out of range.