View Source

Class DefaultPropertyIndexValueFactory

Provides a default implementation for , returning a single field to index containing the property value.

Inheritance

object

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Core.dll

Syntax

public class DefaultPropertyIndexValueFactory : IPropertyIndexValueFactory

Methods

GetIndexValues(IProperty, string?, string?, bool, IEnumerable<string>, IDictionary<Guid, IContentType>)

Gets the index values for a property.

Declaration

public IEnumerable<IndexValue> GetIndexValues(IProperty property, string? culture, string? segment, bool published, IEnumerable<string> availableCultures, IDictionary<Guid, IContentType> contentTypeDictionary)

Parameters

Type	Name	Description
IProperty	property
string	culture
string	segment
bool	published
IEnumerable<string>	availableCultures
IDictionary<Guid, IContentType>	contentTypeDictionary

Returns

Type	Description
IEnumerable<IndexValue>

Remarks

Returns index values for a given property. By default, a property uses its alias as index field name, and there would be only one index value, but some implementations (see for instance the grid one) may return more than one value, with different indexed field names.

And then, values are an enumerable of objects, because each indexed field can in turn have multiple values. By default, there would be only one object: the property value. But some implementations may return more than one value for a given field.