AI OnAI Off

Class TextSearchParameters

Class for parsing and caching text search parameters.

Inheritance
System.Object
TextSearchParameters
Inherited Members
System.Object.ToString()
System.Object.Equals(System.Object)
System.Object.Equals(System.Object, System.Object)
System.Object.ReferenceEquals(System.Object, System.Object)
System.Object.GetHashCode()
System.Object.GetType()
System.Object.MemberwiseClone()
Namespace: EPiServer.Core.Html
Assembly: EPiServer.dll
Version: 8.11.0
Syntax
[Obsolete("This class is no longer being used, indexing is now handled through the Indexing Service")]
public class TextSearchParameters

Constructors

TextSearchParameters()

Declaration
public TextSearchParameters()

TextSearchParameters(String)

Declaration
public TextSearchParameters(string searchKeywords)
Parameters
Type Name Description
System.String searchKeywords

Fields

KEYWORD_WILDCARD

Declaration
public const string KEYWORD_WILDCARD = "*"
Field Value
Type Description
System.String

MaxWords

Declaration
public static readonly int MaxWords
Field Value
Type Description
System.Int32

SearchOnlyWholeWords

Declaration
public bool SearchOnlyWholeWords
Field Value
Type Description
System.Boolean

Properties

ContainsSearchWords

Declaration
public bool ContainsSearchWords { get; }
Property Value
Type Description
System.Boolean

ExcludeWords

Declaration
public List<string> ExcludeWords { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

FileNamePattern

Declaration
public string FileNamePattern { get; set; }
Property Value
Type Description
System.String

Keywords

Declaration
public TextSearchParameters.TextSearchKeywordCollection Keywords { get; }
Property Value
Type Description
TextSearchParameters.TextSearchKeywordCollection

LanguageBranch

Declaration
public string LanguageBranch { get; set; }
Property Value
Type Description
System.String

MandatoryWords

Declaration
public List<string> MandatoryWords { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

MaxModifiedDate

Declaration
public DateTime MaxModifiedDate { get; set; }
Property Value
Type Description
System.DateTime

MinModifiedDate

Declaration
public DateTime MinModifiedDate { get; set; }
Property Value
Type Description
System.DateTime

OptionalWords

Declaration
public List<string> OptionalWords { get; }
Property Value
Type Description
System.Collections.Generic.List<System.String>

Methods

Parse(String)

Declaration
public void Parse(string searchKeywords)
Parameters
Type Name Description
System.String searchKeywords

Parse(String, Boolean)

Declaration
public void Parse(string searchKeywords, bool searchOnlyWholeWords)
Parameters
Type Name Description
System.String searchKeywords
System.Boolean searchOnlyWholeWords

ToArray()

ToArray() - An expensive but simple way to get all words that have been inserted.

Declaration
public string[] ToArray()
Returns
Type Description
System.String[]

Array of strings containing all words
Remarks

The returned words are ordered in their unique index order, as follows;

a mandatory word in the returned list have the same index as a call to ToUniqueMandatoryWordIndex(),

an optional word in the returned list have the same index as a call to ToUniqueOptionalWordIndex(),

an exclude word in the returned list have the same index as a call to ToUniqueExcludeWordIndex().

ToUniqueExcludeWordIndex(Int32)

Declaration
public int ToUniqueExcludeWordIndex(int excludeWordIndex)
Parameters
Type Name Description
System.Int32 excludeWordIndex
Returns
Type Description
System.Int32

The index value transformed to a unique number in the range [mandatory and optional word count] + 1..[total word count].

ToUniqueMandatoryWordIndex(Int32)

Declaration
public int ToUniqueMandatoryWordIndex(int mandatoryWordIndex)
Parameters
Type Name Description
System.Int32 mandatoryWordIndex
Returns
Type Description
System.Int32

The index value transformed to a unique number in the range 1..[mandatory word count].

ToUniqueOptionalWordIndex(Int32)

Declaration
public int ToUniqueOptionalWordIndex(int optionalWordIndex)
Parameters
Type Name Description
System.Int32 optionalWordIndex
Returns
Type Description
System.Int32

The index value transformed to a unique number in the range [mandatory word count] + 1..[mandatory and optional word count].

Extension Methods