How to extend the Search Results widget and filter by library

As the search index does not have the granularity to specify a particular library it is not possible to apply a filter on one or more libraries. This filter can be achieved by extending the Search Results Widget.

Oct 3, 2022
Knowledge

Title

URL Name

How-to-extend-the-Search-Results-widget-and-filter-by-library

Article Number

000187634

Environment

Product: Sitefinity Version: 8.x, 9.x, 10.x, 11.x, 12.x, 13.x, 14.x OS: All supported OS versions Database: Microsoft SQL Server 2012 SP2

Question/Problem Description

How can one filter the search results by library ?

Steps to Reproduce

Clarifying Information

Error Message

Defect Number

Enhancement Number

Cause

Resolution

It is possible to implement this functionality by creating a new custom SearchResults control where the search results can be accessed and manipulated.

This example contains the following steps:

1. Adjusting the Search index

Navigate to Administration > Search indexes and open the particular index.
Add a field in additional fields for indexing in the search index that is known to be a non-default one. This examples uses: LibraryId.
(Doc: http://docs.sitefinity.com/administration-create-search-indexes )

2. Creating the custom DocumentInboundPipe to include the additional field

Create a new class that derives from ContentInboundPipe and overrides the GetConvertedItemsForMapping method where the LibaryId is added:

using System;

using System.Collections.Generic;

using System.Linq;

using System.Web;

using Telerik.Sitefinity.Libraries.Model;

using Telerik.Sitefinity.Publishing;

using Telerik.Sitefinity.Publishing.Pipes;

namespace SitefinityWebApp

{

public class CustomDocumentInboundPipe : DocumentInboundPipe

{

public override IEnumerable<WrapperObject> GetConvertedItemsForMapping(params object[] items)

{

var baseItems = base.GetConvertedItemsForMapping(items);

foreach (var item in baseItems)

{

var doc = (item as WrapperObject).WrappedObject as Document;

(item as WrapperObject).AddProperty("LibraryId", doc.Library.Id);

}

return baseItems;

}

3. Make Sitefinity use the custom pipe instead of the default one

protected void Application_Start(object sender, EventArgs e)

{

PublishingModule.Configured += PublishingModule_Configured;

}

private void PublishingModule_Configured(object sender, EventArgs e)

{

PublishingSystemFactory.UnregisterPipe(DocumentInboundPipe.PipeName);

PublishingSystemFactory.RegisterPipe(DocumentInboundPipe.PipeName, typeof(CustomDocumentInboundPipe));

}

4. Re-index the Search index

Navigate to Administration > Search indexes, choose the particular index and click Actions > Re-index.

5. Creating the new custom Search Results control

Create a new class that inherits from SearchResults, filter the results and adjust the result count.

public class CustomSearchResultsFilter : SearchResults

{

protected override void InitializeControls(Telerik.Sitefinity.Web.UI.GenericContainer container)

{

base.InitializeControls(container);

if (!SystemManager.IsDesignMode)

{

var resultsList = base.ResultsList.DataSource as IEnumerable<IDocument>;

if (resultsList != null)

{

resultsList = resultsList.ToList();

resultsList = resultsList

.Where((t=>t.GetValue("LibraryId").ToString() == "d2cd447e-d2ba-6374-8167-ff0000548a0f"));

string searchwords = this.Query.Trim('\"');

ResultsStats.Text = resultsList.Count().ToString() + " search results for " + HttpUtility.HtmlEncode(searchwords);

}

ResultsList.DataSource = resultsList;

}

else

{

return;

}

Note that in the example the LibaryId (d2cd447e-d2ba-6374-8167-ff0000548a0f) is hardcoded.

Workaround

Notes

Sitefinity Documentation: Customize search results by overriding the SearchResults class
http://docs.sitefinity.com/for-developers-customize-search-results-by-overriding-the-searchresults-class

Keyword Phrase

Last Modified Date

10/3/2022 5:13 PM