SearchBox Class
The SearchBox class implements the search box Web Part on the Microsoft Office SharePoint Portal Server 2003 search page.
System.Object
Microsoft.SharePoint.Portal.WebControls.CacheableWebPart
Microsoft.SharePoint.WebControls.IDesignTimeHtmlProvider
Microsoft.SharePoint.Portal.WebControls.SearchBox
Public Constructors
The following table shows the constructors of the SearchBox class and a brief description of each.
| Name | Description |
|---|---|
| SearchBox | Initializes a new instance of the SearchBox class. |
Public Methods
The following table shows the public methods of the SearchBox class and a brief description of each.
| Name | Description |
|---|---|
| Dispose | Reserved for internal use only. Overrides the Microsoft.SharePoint.WebPartPages.WebPart.Dispose method. Releases all resources used by the Web Part. |
Protected Methods
The following table shows the protected methods of the SearchBox class and a brief description of each.
| Name | Description |
|---|---|
| CreateChildControls | Reserved for internal use only. |
| DetermineTemplateMode | Reserved for internal use only. |
| OnInit(object, System.EventArgs) | Overrides the Microsoft.SharePoint.WebPartPages.WebPart.OnInit method. Raises the System.Web.UI.Control.Init event that occurs as this Web Part is instantiated. |
| OnPreRender(object, System.EventArgs) | Overrides the Microsoft.SharePoint.WebPartPages.WebPart.OnPreRender method. Raises the System.Web.UI.Control.PreRender event that occurs immediately before the Web Part is rendered to its containing Web Parts Page. |
| RenderWebPart(System.Web.UI.HtmlTextWriter) | Overrides the Microsoft.SharePoint.WebPartPages.WebPart.RenderWebPart method. Renders the HTML for the body of this Web Part to the client. |
Public Properties
The following table shows the public properties of the SearchBox class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| CompactMode | Boolean | Gets or sets a flag that determines the display mode for this Web Part. |
| ContextSensitiveScopeType | Int32 | Gets or sets the context for this Web Part. |
| DefaultScopes | String | Reserved for internal use only. |
| EnableCache | Boolean | Gets or sets a flag that indicates whether this Web Part is cached. |
| PromptText | String | Gets or sets the default text displayed in the search box. |
| PromptTextLocId | Microsoft.SharePoint.Portal.WebControls.LocStringId | Gets or sets the unique identifier for the localized version of the prompt text. |
| SearchBoxTableClass | String | Gets or sets the background color for this Web Part. |
| SearchResultPageURL | String | Gets or sets the URL for the page where results are displayed. |
| SearchScopes | String | Reserved for internal use only. |
| SupportThemes | Reserved for internal use only. |
Protected Properties
The following table shows the protected properties of the SearchBox class, the data type of each property, and a brief description of each.
| Name | Data Type | Description |
|---|---|---|
| CacheKey | String | Reserved for internal use only. |
| SupportContextSensitiveScope | Boolean | Gets a flag that indicates whether context-sensitive scopes are enabled for this Web Part. |
Thread Safety
Any public static (Shared in Visual Basic) members of this type are safe for multithreaded operations. Any instance members are not guaranteed to be thread safe.
Requirements
Namespace: Microsoft.SharePoint.Portal.WebControls
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security