Developing the Search page (ASPX)

Kentico allows users to perform index-based searches through all document content, as well as other types of data. The following instructions describe how to add a basic search page to your website.

Configuring search fields for the Computer document type

First, set up the search options for the Computer document type that you created for the Products section.

  1. Open the Document types application.
  2. Edit () the Computer document type.
  3. Switch to the Search fields tab.
  4. Select the Search is enabled check box.
  5. Set the Image field to ComputerImage.
  6. Click Save.

Product documents are now searchable.

Configuring search field settings for a document type

Creating a smart search index

Before you can use the search, you need to add a smart search index covering the website’s documents.

  1. Open the Smart search application.
  2. Click New index.
  3. Fill in the following details for the search index:
    • Display name: My website - Documents
    • Index type: Documents
    • Analyzer type: Standard
    • Stop words: (default)
  4. Click Save. The index’s editing interface opens.
  5. Open the Indexed content tab and click Add allowed content.
  6. Type /% into the Path field and click Save. This ensures that the index includes all documents on the website.
  7. Switch to the Sites tab and assign the index to My website.
  8. Switch to the Cultures tab and choose the default culture of your site (typically English - United States).
  9. Open the General tab and click Rebuild.

Once the system rebuilds the index, you can start using it on the website. The Index info section displays the current status of the index and other relevant information.

Creating a search index for the site’s documents

Preparing the ASPX source files for the search page

  1. Edit your web project in Visual Studio

  2. Right-click the CMSTemplates/MySite folder in the Solution Explorer and click Add -> Add New Item.

  3. Create a Web Form named SearchPage.aspx and check Select master page.

  4. Click Add and choose the MyMaster.master page from the CMSTemplates/MySite folder.

  5. Add the following directive to the beginning of the page code:

     <%@ Register src="~/CMSWebParts/SmartSearch/SearchDialogWithResults.ascx" tagname="SearchDialogWithResults" tagprefix="cms" %>

    This registers the Smart search dialog with results web part as a user control for use on the ASPX template.

  6. Copy the following code inside the <asp:content> element of the page:

     <cms:SearchDialogWithResults ID="SearchDialogWithResults1" runat="server" TransformationName="cms.root.smartsearchresultswithimages" Indexes="MyWebsite-Documents" />

    This adds a heading and the user control (web part) that provides search functionality and displays the results. The control uses the My website - Documents search index created in the previous section, which is assigned through the Indexes property (identified by the index code name).

  7. Switch to the code behind of the search page (SearchPage.aspx.cs) and add a reference to the CMS.UIControls namespace:

     using CMS.UIControls;
  8. Change the class definition so that it inherits from the TemplatePage class:

     public partial class CMSTemplates_MySite_SearchPage : TemplatePage
  9. Save the search page files.

Registering the page template

The source files of the search page are ready. Now you need to register the page template in Kentico.

  1. Switch to the Kentico administration interface in your browser.
  2. Open the Page templates application.
  3. Select the My website category.
  4. Click New template and type Search page into the Template display name field.
  5. Click Save.
  6. Set the following values on the General tab:
    • Template type: ASPX page
    • File name: ~/CMSTemplates/MySite/SearchPage.aspx
  7. Click Save.
  8. Switch to the Sites tab and assign the page template to My website.

Adding the search page

  1. Open the Pages application.
  2. Select the root of the content tree (My website).
  3. Click New ().
  4. Choose the Page (menu item) document type.
  5. Type in Search as the Page name and choose the Use existing page template option. Select the My website category and the Search page template.
  6. Click Save to create the page.
  7. Drag the Search page to the end of the content tree.

To try out the search functionality, view the /Search page in Preview mode. Type PC into the Search for box and click Search.

Searching the website

When you click a search result, the system redirects you to the corresponding page.

Modifying the format of the search results

If you prefer a different design of the search results, you can modify the format by editing the SmartSearchResults (or SmartSearchResultsWithImages) transformation in Document types -> Root -> Transformations.