View Source

Class DefaultPropertyIndexValueFactory

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

Inheritance

System.Object

Namespace: Umbraco.Cms.Core.PropertyEditors

Assembly: Umbraco.Core.dll

Syntax

public class DefaultPropertyIndexValueFactory : IPropertyIndexValueFactory

Methods

GetIndexValues(IProperty, String, String, Boolean)

Declaration

public IEnumerable<KeyValuePair<string, IEnumerable<object>>> GetIndexValues(IProperty property, string culture, string segment, bool published)

Parameters

Type	Name	Description
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

GetIndexValues(IProperty, String, String, Boolean, IEnumerable<String>)

Gets the index values for a property.

Declaration

public IEnumerable<KeyValuePair<string, IEnumerable<object>>> GetIndexValues(IProperty property, string culture, string segment, bool published, IEnumerable<string> availableCultures)

Parameters

Type	Name	Description
IProperty	property
System.String	culture
System.String	segment
System.Boolean	published
IEnumerable<System.String>	availableCultures

Returns

Type	Description
IEnumerable<KeyValuePair<System.String, IEnumerable<System.Object>>>

Remarks

Returns key-value pairs, where keys are indexed field names. By default, that would be the property alias, and there would be only one pair, but some implementations (see for instance the grid one) may return more than one pair, 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.