SearchScope Class
The SearchScope class defines how a logical scope is defined on top of the physical content sources. Each SearchScope object corresponds to a drop-down item in the SearchBox scope selections on a home page. The SearchScope class is a collection of SearchScopeEntity objects.
System.Object
Microsoft.SharePoint.Portal.Search.ObjectModel.SearchScope
Public Constructors
The following table shows the constructors of the SearchScope class and a brief description of each.
| Name | Description |
|---|---|
| SearchScope(String, Int32, Boolean) | Initializes a new instance of the SearchScope class. |
| SearchScope(String, Int32, Boolean, Microsoft.SharePoint.Portal.PortalContext) | Initializes a new instance of the SearchScope class. |
Public Methods
The following table shows the public methods of the SearchScope class and a brief description of each.
| Name | Description |
|---|---|
| AddSearchScopeEntity(Microsoft.SharePoint.Portal.Search.ObjectModel.SearchScopeEntity) | Adds a new SearchScopeEntity object to this search scope. |
| GetEntities | Gets all of the SearchScopeEntity objects for this search scope. |
| Reset | Removes all SearchScopeEntity objects in this search scope. |
Public Properties
The following table shows the properties of the SearchScope class, the data type of each property, and a brief description of each.
| Name | Data type | Description |
|---|---|---|
| IsDefault | Boolean | Gets a value indicating whether this search scope is the default search scope. A default search scope is the one selected by default in the search box scope drop-down list on the home page. |
| Name | String | Gets the name of this search scope that appears in the search box scope drop-down list. |
| NumEntities | Int32 | Gets the number of SearchScopeEntity objects for this search scope. |
Thread Safety
Any public static (Shared in Microsoft Visual Basic) members of this type are safe for multithreaded operations. Instance members are not guaranteed to be thread safe.
Requirements
Namespace: Microsoft.SharePoint.Portal.Search.ObjectModel
Platforms: Microsoft Windows Server 2003
Assembly: Microsoft.SharePoint.Portal (in Microsoft.SharePoint.Portal.dll)
Security: Code Access Security