SearchBoxEx members

Implements the search box Web Part on the Microsoft Office SharePoint Server 2007 search page.

The SearchBoxEx type exposes the following members.

Constructors

  Name Description
Public method SearchBoxEx Initializes a new instance of the SearchBox class.

Top

Properties

  Name Description
Public property AdvancedSearchPageURL Gets or sets the URL for the Advanced Search page.
Public property AppendToQuery Gets or sets a Boolean value indicating whether additional query terms are appended to the search query entered by the user into the search box Web Part.
Public property AppQueryTerms Gets or sets the additional query terms appended to the search query entered by the user into the search box Web Part.
Public property AppQueryTermsLabel Gets or sets text describing query terms appended to the user's search query.
Protected property DefaultResultsPage
Public property DisplaySubmittedSearch Gets or sets a Boolean value indicating whether the search terms are displayed in the search box Web Part.
Public property DropDownMode Gets or sets the display mode for the search box Web Part's scopes dropdown.
Public property DropDownModeEx Gets or sets the display mode for the search box Web Part's scopes dropdown in the search box Web Part.
Public property DropDownWidth Gets or sets the fixed width for the scopes dropdown in the search box Web Part.
Public property GoImageActiveUrl Gets or sets the link for the active search buttonimage.
Public property GoImageActiveUrlRTL Gets or sets the link for the active search button right-to-left image.
Public property GoImageUrl Gets or sets the link for the search button image.
Public property GoImageUrlRTL Gets or sets the link for the search button right-to-left image.
Public property IsMysiteSearchBox
Protected property NothingShouldBeRendered
Public property QueryPromptString Gets or sets the search box Web Part's query prompt text.
Public property QuerySuggestionsCompletionInterval
Public property QuerySuggestionsCompletionSetCount
Public property QuerySuggestionsMinimumPrefixLength
Public property RegisterStyles
Public property ScopeDisplayGroupName Gets or sets the scope display group name for the search box Web Part.
Public property SearchBoxTableClass
Public property SearchBoxVisual
Public property SearchResultPageURL Gets or sets the URL for the page where SharePoint Enterprise Search results are displayed.
Public property ShouldTakeFocusIfEmpty Gets or sets a Boolean value indicating whether the search box Web Part receives focus if it is empty.
Public property ShowAdvancedSearch Gets or sets a Boolean value indicating whether a link to the Advanced Search page is displayed.
Public property ShowPerferenceLink
Public property ShowQuerySuggestions
Public property TextBeforeDropDown Gets or sets the text displayed in front of the search box Web Part's scopes dropdown.
Public property TextBeforeTextBox Gets or sets the text displayed in front of the search box Web Part's query text box.
Public property TextBoxWidth Gets or sets the fixed width for the query text box in the search box Web Part.
Public property UseSiteDefaults Specifies whether the Advanced Search link is actually displayed.
Public property UseSiteDropDownMode

Top

Methods

  Name Description
Public method AfterDeserialize (Overrides WebPart.AfterDeserialize().)
Protected method CreateChildControls Used to create the controls in the search box Web Part. (Overrides WebPartLocCreateChildControls().)
Public method GetToolParts Overrides the GetToolParts method of the WebPart base class. (Overrides WebPart.GetToolParts().)
Public method LoadResource Returns a string that describes the localized Name, Category, and Description property values of the specified resource. (Overrides WebPartLocLoadResource(String).)
Protected method OnInit detect the browser setting. Prepare the Ids Fetch the variables from url if they exist. We look for 'k' 's' 'cs' 'rs' and 'u' in Url (Overrides WebPartLocOnInit(Object, EventArgs).)
Protected method OnLoad (Overrides WebPartLocOnLoad(Object, EventArgs).)
Protected method OnPreRender If scoping is enabled then we make sure that there is a default scope. if the default scope is contextual scope then we also need contextual scope property and real name for the scope. If we got a contextual scope from url then we add that to scope drop down. Right now it is added to the end, but the correct behavior should be to add to the top. The script needed for Go Button is added at the bottom. (Overrides WebPartLocOnPreRender(Object, EventArgs).)
Protected method PrefixPartSpecificID This member is reserved for internal use and is not intended to be used directly from your code.
Protected method RenderWebPart (Overrides WebPartLocRenderWebPart(HtmlTextWriter).)
Protected method RequiresWebPartClientScript (Overrides WebPart.RequiresWebPartClientScript().)

Top

Fields

  Name Description
Protected field m_ddlScopes
Protected field m_hlink
Protected field m_searchKeyWordTextBox
Protected field m_strKSFromPostOrGetOverride
Protected fieldStatic member PreferencesLink

Top

See also

Reference

SearchBoxEx class

Microsoft.SharePoint.Portal.WebControls namespace