Class FileIndexBuilder

Namespace

Dynamicweb.Content.Files

Assembly

Dynamicweb.dll

[AddInName("File Index Builder")]
public class FileIndexBuilder : IndexBuilderBase, IIndexBuilder

Inheritance

object

ConfigurableAddIn

IndexBuilderBase

FileIndexBuilder

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

DefaultSettings

Default settings

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

Property Value

IDictionary<string, object>

Recursive

[AddInParameterGroup("File Index Builder Settings")]
[AddInParameter("Recursive")]
[AddInLabel("Recursive")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "Explanation=Controls whether subfolder content is indexed, by default it is;")]
public bool Recursive { get; set; }

Property Value

bool

SkipDynamicwebMetadata

[AddInParameterGroup("File Index Builder Settings")]
[AddInParameter("SkipDynamicwebMetadata")]
[AddInLabel("Skip Dynamicweb metadata")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "")]
public bool SkipDynamicwebMetadata { get; set; }

Property Value

bool

SkipMetadata

[AddInParameterGroup("File Index Builder Settings")]
[AddInParameter("SkipMetadata")]
[AddInLabel("Skip metadata")]
[AddInParameterEditor(typeof(YesNoParameterEditor), "Explanation=Skips metadata like EXIF, XMP, IPTC on image files;")]
public bool SkipMetadata { get; set; }

Property Value

bool

StartFolder

[AddInParameterGroup("File Index Builder Settings")]
[AddInParameter("StartFolder")]
[AddInLabel("Start folder")]
[AddInParameterEditor(typeof(TextParameterEditor), "infoText=Defaults to 'Files'; Explanation=Controls which folder to index;")]
public string StartFolder { get; set; }

Property Value

string

SupportedActions

List of supported actions

public override IEnumerable<string> SupportedActions { get; }

Property Value

IEnumerable<string>

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()

Defines GetFields required operation

public override IEnumerable<FieldDefinitionBase> GetFields()

Returns

IEnumerable<FieldDefinitionBase>