Class ContentIndexBuilder

Namespace

Dynamicweb.Content

Assembly

Dynamicweb.dll

ContentIndexProvider implements a IndexBuilderBase that indexes Pages, paragraphs and items to the index.

[AddInName("Content Index Builder")]
public class ContentIndexBuilder : IndexBuilderBase, IIndexBuilder

Inheritance

object

ConfigurableAddIn

IndexBuilderBase

ContentIndexBuilder

Implements

IIndexBuilder

Inherited Members

IndexBuilderBase.Name

IndexBuilderBase.Type

IndexBuilderBase.Action

IndexBuilderBase.Settings

IndexBuilderBase.Meta

IndexBuilderBase.Extenders

IndexBuilderBase.Schema

IndexBuilderBase.Notification

IndexBuilderBase.SetValue<T>(string, T)

IndexBuilderBase.GetBoolean(string)

IndexBuilderBase.GetInt32(string)

IndexBuilderBase.GetString(string)

ConfigurableAddIn.UpdateFromPost(NameValueCollection)

ConfigurableAddIn.GetIdSuitableString(string)

ConfigurableAddIn.LoadParametersFromXml(string)

ConfigurableAddIn.GetParametersToXml()

ConfigurableAddIn.GetParametersToXml(bool)

ConfigurableAddIn.SetValue(string, object)

ConfigurableAddIn.GetInstanceFromParameterXml<T>(string)

ConfigurableAddIn.RenderAdditionalContent(TextWriter)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Properties

AppsToHandle

[AddInParameterGroup("Content Index Builder Settings")]
[AddInParameter("AppsToHandle")]
[AddInLabel("Apps to handle")]
[AddInParameterEditor(typeof(TextParameterEditor), "infoText=Defaults to all; Explanation=Allows specification of ContentAppIndexProviders via a comma-separated list;")]
public string AppsToHandle { get; set; }

Property Value

string

DefaultSettings

Gets default settings collection

public override IDictionary<string, object> DefaultSettings { get; }

Property Value

IDictionary<string, object>

ExcludeItemsFromIndex

[AddInParameterGroup("Content Index Builder Settings")]
[AddInParameter("ExcludeItemsFromIndex")]
[AddInLabel("Exclude Items from Index")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "Explanation=Excludes item content from the index;")]
public bool ExcludeItemsFromIndex { get; set; }

Property Value

bool

SkipPageItemRelationLists

[AddInParameterGroup("Content Index Builder Settings")]
[AddInParameter("SkipPageItemRelationLists")]
[AddInLabel("Skip page Item relation lists")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipPageItemRelationLists { get; set; }

Property Value

bool

SkipParagraphItemRelationLists

[AddInParameterGroup("Content Index Builder Settings")]
[AddInParameter("SkipParagraphItemRelationLists")]
[AddInLabel("Skip paragraph Item relation lists")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipParagraphItemRelationLists { get; set; }

Property Value

bool

SupportedActions

List of supported actions, currently just supports full indexing.

public override IEnumerable<string> SupportedActions { get; }

Property Value

IEnumerable<string>

The supported actions.

Methods

Build(IIndexWriter, Tracker)

Builds the index to the specified writer.

public override void Build(IIndexWriter writer, Tracker tracker)

Parameters

writer IIndexWriter

The indexing writer.

tracker Tracker

The tracker instance to log what happens.

GetFields()

Returns the fields that this provider supports - a list of page, paragraph and item fields.

public override IEnumerable<FieldDefinitionBase> GetFields()

Returns

IEnumerable<FieldDefinitionBase>

IList(Of FieldDefinition).

See Also

IndexBuilderBase