Class BlockValuePropertyValueEditorBase<TValue, TLayout>

Inheritance

object

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Infrastructure.dll

Syntax

public abstract class BlockValuePropertyValueEditorBase<TValue, TLayout> : DataValueEditor, IDataValueEditor, IDataValueReference, IDataValueTags where TValue : BlockValue<TLayout>, new() where TLayout : class, IBlockLayoutItem, new()

Type Parameters

Name	Description
TValue
TLayout

Constructors

View Source

BlockValuePropertyValueEditorBase(PropertyEditorCollection, IDataTypeConfigurationCache, IShortStringHelper, IJsonSerializer, DataValueReferenceFactoryCollection, BlockEditorVarianceHandler, ILanguageService, IIOHelper, DataEditorAttribute)

Declaration

protected BlockValuePropertyValueEditorBase(PropertyEditorCollection propertyEditors, IDataTypeConfigurationCache dataTypeConfigurationCache, IShortStringHelper shortStringHelper, IJsonSerializer jsonSerializer, DataValueReferenceFactoryCollection dataValueReferenceFactoryCollection, BlockEditorVarianceHandler blockEditorVarianceHandler, ILanguageService languageService, IIOHelper ioHelper, DataEditorAttribute attribute)

Parameters

Type	Name	Description
PropertyEditorCollection	propertyEditors
IDataTypeConfigurationCache	dataTypeConfigurationCache
IShortStringHelper	shortStringHelper
IJsonSerializer	jsonSerializer
DataValueReferenceFactoryCollection	dataValueReferenceFactoryCollection
BlockEditorVarianceHandler	blockEditorVarianceHandler
ILanguageService	languageService
IIOHelper	ioHelper
DataEditorAttribute	attribute

Properties

View Source

BlockEditorValues

Declaration

protected BlockEditorValues<TValue, TLayout> BlockEditorValues { get; set; }

Property Value

Type	Description
BlockEditorValues<TValue, TLayout>

Methods

View Source

CacheReferencedEntities(BlockEditorData<TValue, TLayout>?)

Caches referenced entities for all property values with supporting property editors within the specified block editor data optimising subsequent retrieval of entities when parsing and converting property values.

Declaration

[Obsolete("This method is available for support of request caching retrieved entities in derived property value editors. The intention is to supersede this with lazy loaded read locks, which will make this unnecessary. Scheduled for removal in Umbraco 19.")]
protected void CacheReferencedEntities(BlockEditorData<TValue, TLayout>? blockEditorData)

Parameters

Type	Name	Description
BlockEditorData<TValue, TLayout>	blockEditorData	The block editor data containing content and settings property values to analyze for referenced entities.

Remarks

This method iterates through all property values associated with data editors in the provided block editor data and invokes caching for referenced entities where supported by the property editor.

View Source

ConfiguredElementTypeKeys(IBlockConfiguration)

Declaration

protected IEnumerable<Guid> ConfiguredElementTypeKeys(IBlockConfiguration configuration)

Parameters

Type	Name	Description
IBlockConfiguration	configuration

Returns

Type	Description
IEnumerable<Guid>

View Source

CreateWithLayout(IEnumerable<TLayout>)

Declaration

protected abstract TValue CreateWithLayout(IEnumerable<TLayout> layout)

Parameters

Type	Name	Description
IEnumerable<TLayout>	layout

Returns

Type	Description
TValue

View Source

GetBlockValueReferences(TValue)

Declaration

protected IEnumerable<UmbracoEntityReference> GetBlockValueReferences(TValue blockValue)

Parameters

Type	Name	Description
TValue	blockValue

Returns

Type	Description
IEnumerable<UmbracoEntityReference>

View Source

GetBlockValueTags(TValue, int?)

Declaration

protected IEnumerable<ITag> GetBlockValueTags(TValue blockValue, int? languageId)

Parameters

Type	Name	Description
TValue	blockValue
int?	languageId

Returns

Type	Description
IEnumerable<ITag>

View Source

GetReferences(object?)

Returns any references contained in the value

Declaration

public abstract IEnumerable<UmbracoEntityReference> GetReferences(object? value)

Parameters

Type	Name	Description
object	value

Returns

Type	Description
IEnumerable<UmbracoEntityReference>

View Source

GetTags(object?, object?, int?)

Returns any tags contained in the value

Declaration

public abstract IEnumerable<ITag> GetTags(object? value, object? dataTypeConfiguration, int? languageId)

Parameters

Type	Name	Description
object	value
object	dataTypeConfiguration
int?	languageId

Returns

Type	Description
IEnumerable<ITag>

View Source

MapBlockValueFromEditor(TValue?, TValue?, Guid)

Declaration

protected void MapBlockValueFromEditor(TValue? editedBlockValue, TValue? currentBlockValue, Guid contentKey)

Parameters

Type	Name	Description
TValue	editedBlockValue
TValue	currentBlockValue
Guid	contentKey

View Source

MapBlockValueToEditor(IProperty, TValue, string?, string?)

Declaration

protected void MapBlockValueToEditor(IProperty property, TValue blockValue, string? culture, string? segment)

Parameters

Type	Name	Description
IProperty	property
TValue	blockValue
string	culture
string	segment

View Source

MergeBlockEditorDataForCulture(TValue, TValue, string?)

Declaration

protected TValue MergeBlockEditorDataForCulture(TValue sourceBlockValue, TValue targetBlockValue, string? culture)

Parameters

Type	Name	Description
TValue	sourceBlockValue
TValue	targetBlockValue
string	culture

Returns

Type	Description
TValue