Alias dictionary Leave feedback

An instance of the AliasDictionary class contains all the aliases defined in an index. Information on using aliases to search is provided on the Using aliases page.

To get the number of existing aliases, use the Count property.

Use the Add method to add a new alias-replacement pair. An alias can contain only Latin letters and digits; the leading @ character is optional. The letter case of aliases is ignored.

Use the AddRange method to add a collection of new alias-replacement pairs.

To remove an alias from the dictionary, use the Remove method.

The Contains method is used to check for the presence of a particular alias in the dictionary.

To get a replacement for a particular alias, use the GetText method.

The Clear method is used to remove all existing aliases from the dictionary.

The alias dictionary can be changed at any time, also in an index that contains documents.

To export the list of aliases with replacements to a file, use the ExportDictionary method.

To import the list of aliases from a file, use the ImportDictionary method. Errors of exporting and importing are reported by the ErrorOccurred event of the index instead of exceptions.

The following example demonstrates the use of methods of the alias dictionary.

C#

string indexFolder = @"c:\MyIndex\";

// Creating or opening an index in the specified folder
Index index = new Index(indexFolder);

if (index.Dictionaries.AliasDictionary.Count > 0)
{
    // Deleting all existing aliases
    index.Dictionaries.AliasDictionary.Clear();
}

// Adding aliases to the alias dictionary
index.Dictionaries.AliasDictionary.Add("t", "(theory OR relativity)");
index.Dictionaries.AliasDictionary.Add("e", "(Einstein OR Albert)");
AliasReplacementPair[] pairs = new AliasReplacementPair[]
{
    new AliasReplacementPair("d", "daterange(2017-01-01 ~~ 2019-12-31)"),
    new AliasReplacementPair("n", "(100 ~~ 900)"),
};
index.Dictionaries.AliasDictionary.AddRange(pairs);

if (index.Dictionaries.AliasDictionary.Contains("e"))
{
    // Getting an alias replacement
    string replacement = index.Dictionaries.AliasDictionary.GetText("e");
    Console.WriteLine("e - " + replacement);
}

// Exporting aliases to a file
index.Dictionaries.AliasDictionary.ExportDictionary(@"c:\Aliases.dat");

// Importing aliases from a file
index.Dictionaries.AliasDictionary.ImportDictionary(@"c:\Aliases.dat");

// Searching in the index
SearchResult result = index.Search("@t OR @e");

You may easily run the code from documentation articles and see the features in action in our GitHub examples:

• GroupDocs.Search for .NET examples

• GroupDocs.Search for Java examples

Along with full featured .NET library we provide simple, but powerful free Apps.

You are welcome to search over your PDF, DOC, DOCX, PPT, PPTX, XLS, XLSX and more with our free online Free Online Document Search App.