Click here to Skip to main content
Click here to Skip to main content

Search User Controls for Microsoft Office SharePoint Server (MOSS)

By , 29 Aug 2008
Rate this:
Please Sign up or sign in to vote.
Screenshot - sample.gif

Introduction

Although the out-of-the-box search Web parts provided by Microsoft Office SharePoint Server (MOSS) 2007 are very customizable, there are situations where you may want to develop your search interface to hook into MOSS. This download consists of a Search Box user control and a Search Results user control. The Search Results user control uses the new FullTextSqlQuery API to return the search results. As user controls (I might add a Web part version later), the look and feel are very easy to customize.

Description

The Search Box user control SearchBox.ascx has several public properties:

  • SearchResultsUrl - URL of the search results page. Default is the current page.
  • DefaultSearchScope - Default search scope. Default is All Sites.
  • SearchScopes - A comma delimited list of search scopes. If provided, they will be rendered in a dropdown list for user to limit the scope of the search.

The Search Results user control SearchResults.ascx has several public properties:

  • ResultFields - A comma delimited list of result fields. Default is WorkId, Rank, Title, Author, Size, Path, Description, Write, SiteName, CollapsingStatus, HitHighlightedSummary, HitHighlightedProperties, ContentClass, IsDocument, PictureThumbnailURL.
  • RowLimit - The number of search result items returned per page. Default is 10.
  • HitHighlightedTag - The HTML tag (without the enclosing angled brackets) to highlight the search words when rendering the result field HitHighlightedSummary. Default is b for bold.

Installation

The sample Visual Studio 2005 SP1 solution includes all the support files you need to build and deploy the user controls, minus strong name key files (*.snk). (The supplied Visual Studio 2005 solution contains Web Application projects supported only by SP1 or after.) It contains two projects: Deployment and Office.Server.Search. The Office.Server.Search project contains source codes for the user controls. The Deployment project contains a pre-build script to aggregate all the files needed for deployment. It contains a Solution directory where a WSP file is generated and deployed by a post-build script.

This structure of Visual Studio solution and projects is designed to be scalable to full blown MOSS/WSS development and deployment. You could add additional projects like SharePoint for WSS/MOSS development or SharePoint.Publishing for MOSS Publishing development. Within your projects, you could have other custom components like Web controls, Web parts, custom fields, feature receivers etc.

Of course you can install the user controls as is without further customization. Using stsadm, install the solution file QuestechSolution.wsp in \Deployments\Solution\:

stsadm -o addsolution -filename QuestechSolution.wsp

Then go to SharePoint Central Administration/Operations/Global Configuration-Solution Management and deploy the solution to selected Web applications. To insert the user controls to a page, modify the appropriate master page or page layout as follows:

...
<%@ Register TagPrefix="Questech" TagName="SearchBox"
      src="~/_controltemplates/Questech/SearchBox.ascx" %>

<%@ Register TagPrefix="Questech" TagName="SearchResults"
      src="~/_controltemplates/Questech/SearchResults.ascx" %>
...
...
<Questech:SearchBox id="SearchBox" runat="server" />

 ... 
<Questech:SearchResults id="SearchResults" runat="server" />
...

References

  1. Enterprise Search Query Object Model Overview
  2. Custom Enterprise Search Web Part Code
  3. Creating a Web part to explicitly search custom columns in MOSS 2007 - Part 1 and 2
  4. MOSS - Search Scopes

History

  • V1.2 - 2008.08.26 - Added support for sites run under extended web applications
  • V1.1 - 2008.04.22
    • Included sample Visual Studio 2005 solution for compiling and deploying the user controls
    • Updated installation instructions
  • V1.0 - 2007.03.22 - Base

License

This article, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

About the Author

Stephen Huen
Web Developer Questech Systems
Canada Canada
No Biography provided

Comments and Discussions

 
QuestionIts not working Pinmemberkarthikmandadi@gmail.com25-Jul-12 20:50 
GeneralCustom search in WSS 3.0 Pinmembersmasher91-Aug-09 17:16 
Questionproblem with PATH property in extended site Pinmemberbilalfastian25-Aug-08 10:14 
I used these controls on my site. They worked perfect
 
After that I extended my site for an extranet zone.
 
The problem is that the PATH property still returns the original site URL and not the extended site URL. How can I get the extranet site URL in PATH property? Is there any other property which I can use to get the file path.
 
Urgent help will be highly appreciated.
 
regards
Bilal Ahmad
AnswerRe: problem with PATH property in extended site PinmemberStephen Huen26-Aug-08 9:28 
QuestionHow to set Public Properties PinmemberBharat Chopra28-Apr-08 5:03 
AnswerRe: How to set Public Properties PinmemberStephen Huen29-Apr-08 16:22 
GeneralHitHighLightedSummary PinmemberSearchDeveloper29-Jan-08 4:24 
Generalows_name(Text) PinmemberSearchDeveloper15-Jan-08 8:15 
GeneralSearch PinmemberSearchDeveloper12-Dec-07 4:30 
GeneralScopes PinmemberSearchDeveloper4-Dec-07 4:44 
GeneralHelp in Search PinmemberSearchDeveloper29-Nov-07 10:43 
GeneralRe: Help in Search PinmemberStephen Huen29-Nov-07 14:00 
GeneralRe: Help in Search PinmemberSearchDeveloper30-Nov-07 11:34 
GeneralRegarding PictureThumbNailURL PinmemberSearchDeveloper28-Nov-07 9:28 
GeneralRe: Regarding PictureThumbNailURL PinmemberStephen Huen28-Nov-07 11:40 
QuestionQuestion on Search PinmemberVvenkatesan28-Nov-07 3:51 
AnswerRe: Question on Search PinmemberStephen Huen28-Nov-07 10:36 
GeneralRe: Question on Search PinmemberVvenkatesan28-Nov-07 10:38 
GeneralRegarding Scope PinmemberSearchDeveloper27-Nov-07 6:05 
GeneralRe: Regarding Scope PinmemberStephen Huen27-Nov-07 8:41 
GeneralAdvance Search PinmemberVvenkatesan26-Nov-07 8:55 
Generalwebpart for custom search using keyword query class(creating a search restriction) Pinmembershareknk19-Nov-07 23:32 
GeneralRegarding Search PinmemberSearchDeveloper13-Nov-07 10:57 
GeneralRe: Regarding Search PinmemberStephen Huen13-Nov-07 21:34 
GeneralRe: Regarding Search PinmemberSearchDeveloper14-Nov-07 9:44 

General General    News News    Suggestion Suggestion    Question Question    Bug Bug    Answer Answer    Joke Joke    Rant Rant    Admin Admin   

Use Ctrl+Left/Right to switch messages, Ctrl+Up/Down to switch threads, Ctrl+Shift+Left/Right to switch pages.

| Advertise | Privacy | Mobile
Web01 | 2.8.140415.2 | Last Updated 29 Aug 2008
Article Copyright 2007 by Stephen Huen
Everything else Copyright © CodeProject, 1999-2014
Terms of Use
Layout: fixed | fluid