View Source

Class BlockEditorVarianceHandler

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.PropertyEditors.ValueConverters

Assembly: Umbraco.Infrastructure.dll

Syntax

public sealed class BlockEditorVarianceHandler

Constructors

BlockEditorVarianceHandler(ILanguageService, IContentTypeService)

Declaration

public BlockEditorVarianceHandler(ILanguageService languageService, IContentTypeService contentTypeService)

Parameters

Type	Name	Description
ILanguageService	languageService
IContentTypeService	contentTypeService

Methods

AlignedExposeVarianceAsync(BlockValue, IPublishedElement, IPublishedElement)

Aligns a block value for variance changes.

Declaration

public async Task<IEnumerable<BlockItemVariation>> AlignedExposeVarianceAsync(BlockValue blockValue, IPublishedElement owner, IPublishedElement element)

Parameters

Type	Name	Description
BlockValue	blockValue	The block property value to align.
IPublishedElement	owner	The owner element (the content for block properties at content level, or the parent element for nested block properties).
IPublishedElement	element	The containing block element.

Returns

Type	Description
Task<IEnumerable<BlockItemVariation>>

Remarks

Used for aligning variance changes when rendering content.

AlignedPropertyVarianceAsync(BlockPropertyValue, IPublishedPropertyType, IPublishedElement)

Aligns a block property value for variance changes.

Declaration

public async Task<BlockPropertyValue> AlignedPropertyVarianceAsync(BlockPropertyValue blockPropertyValue, IPublishedPropertyType propertyType, IPublishedElement owner)

Parameters

Type	Name	Description
BlockPropertyValue	blockPropertyValue	The block property value to align.
IPublishedPropertyType	propertyType	The underlying property type.
IPublishedElement	owner	The containing block element.

Returns

Type	Description
Task<BlockPropertyValue>

Remarks

Used for aligning variance changes when rendering content.

AlignExposeVariance(BlockValue)

Aligns block value expose for variance changes.

Declaration

public void AlignExposeVariance(BlockValue blockValue)

Parameters

Type	Name	Description
BlockValue	blockValue	The block value to align.

Remarks

Used for aligning variance changes when editing content.

This is expected to be invoked after all block values have been aligned for variance changes by AlignPropertyVarianceAsync(BlockPropertyValue, IPropertyType, String).

AlignPropertyVarianceAsync(IList<BlockPropertyValue>, String)

Aligns a collection of block property values for variance changes.

Declaration

public async Task<IList<BlockPropertyValue>> AlignPropertyVarianceAsync(IList<BlockPropertyValue> blockPropertyValues, string culture)

Parameters

Type	Name	Description
IList<BlockPropertyValue>	blockPropertyValues	The block property values to align.
System.String	culture	The culture being handled (null if invariant).

Returns

Type	Description
Task<IList<BlockPropertyValue>>

Remarks

Used for aligning variance changes when editing content.

AlignPropertyVarianceAsync(BlockPropertyValue, IPropertyType, String)

Declaration

public async Task AlignPropertyVarianceAsync(BlockPropertyValue blockPropertyValue, IPropertyType propertyType, string culture)

Parameters

Type	Name	Description
BlockPropertyValue	blockPropertyValue
IPropertyType	propertyType
System.String	culture

Returns

Type	Description
Task