Include Protected Members
Include Inherited Members
Defines the functionality to administer Search scopes in a farm.
The ScopesManager type exposes the following members.
Constructors
| Name | Description | |
|---|---|---|
![]()  | 
ScopesManager | Initializes a new instance of the ScopesManager class. | 
Top
Properties
| Name | Description | |
|---|---|---|
![]()  | 
AllDisplayGroups | When overridden in a derived class, gets the collection of scope display groups managed by the ScopesManager. | 
![]()  | 
AllScopes | When overridden in derived class, gets a collection that contains all of the scopes managed by the ScopesManager. | 
![]()  | 
AverageCompilationDuration | Gets the average compilation time for the Search scopes. | 
![]()  | 
CompilationPercentComplete | Gets the percentage of compilation completed for the Search scope system. | 
![]()  | 
CompilationScheduleType | When overridden in derived classes, gets or sets the time when the scope compilation is scheduled. | 
![]()  | 
CompilationState | Gets the compilation state of the Search scope system. | 
![]()  | 
LastCompilationTime | Gets the date and time of the last compilation for the Search scope system. | 
![]()  | 
LogPrefix | When overridden in a derived class, gets the prefix that is prepended to each log statement. | 
![]()  | 
NextCompilationTime | Gets the date and time for the next compilation of the Search scope system. | 
![]()  | 
ScopesNeedingCompilation | Gets the number of scopes that need to be compiled. | 
Top
Methods
| Name | Description | |
|---|---|---|
![]()  | 
ConstructDisplayGroupFromInfo | Creates a scope display group with the specified scope display group information. | 
![]()  | 
ConstructRuleFromRuleInfo | Creates a Search scope rule with specified Search scope rule information. | 
![]()  | 
ConstructScopeFromScopeInfo | Creates a Search scope with specified Search scope information. | 
![]()  | 
EnsureFresh | Refreshes the Search scope compilation information if the information is stale. | 
![]()  | 
EnsurePopulated | Sets the Search scope compilation information to the default global values if not already set. | 
![]()  | 
Equals | (Inherited from Object.) | 
![]()  | 
Finalize | (Inherited from Object.) | 
![]()  | 
GetDisplayGroup | When overridden in a derived class, gets the scope display group the with specified site URI and name. | 
![]()  | 
GetDisplayGroupsForSite | When overridden in a derived class, gets an enumerator to access the list of the ScopeDisplayGroup objects. | 
![]()  | 
GetHashCode | (Inherited from Object.) | 
![]()  | 
GetRulesInfo | Gets a key/value pair of Search scope rules from the specified rule information collection. | 
![]()  | 
GetScope | Gets the Search scope. | 
![]()  | 
GetScopesForSite | When overridden in a derived class, gets an enumerator to access the collection of scopes for a specified site. | 
![]()  | 
GetSharedScope | When overridden in a derived class, gets the global scope with the specified name. | 
![]()  | 
GetSharedScopes | When overridden in a derived class, gets an enumerator to access a list of global search Scope objects that are available on any server in the SPFarm. | 
![]()  | 
GetType | (Inherited from Object.) | 
![]()  | 
GetUnusedScopesForSite | When overridden in a derived class, gets an enumerator to access the list of the search Scope objects that are not used by any Search scope display group. | 
![]()  | 
InitializeDetails | Initializes the Search scope compilation information by using the specified global settings. | 
![]()  | 
InitializeVolatileDetails | Initializes the Search scope compilation information by using the specified volatile global settings. | 
![]()  | 
MemberwiseClone | (Inherited from Object.) | 
![]()  | 
Populate | When overridden in a derived class, resets the Search scope compilation information to the default global values. | 
![]()  | 
PruneDisplayGroupList | Gets an enumerator to access the list of ScopeDisplayGroup objects associated with the specified list of information about Search display groups. | 
![]()  | 
PruneScopeList | Gets an enumerator to access the list of Scope objects associated with the specified list of information about scopes. | 
![]()  | 
Refresh | When overridden in derived classes, reloads the volatile Search scope compilation information by using information from the Search administration database. | 
![]()  | 
SetDisplayGroupDetails | Sets the detailed information about the specified scope display group with the specified display group information. | 
![]()  | 
SetScopeInfoOnScope | Sets the detailed information about the specified scope with the specified scope information. | 
![]()  | 
StartCompilation | When overridden in a derived class, starts the Search scope compilation in the Search service application. | 
![]()  | 
ToString | (Inherited from Object.) | 
![]()  | 
Update | When overridden in a derived class, updates the Search Scope compilation schedule information. | 
Top
Fields
| Name | Description | |
|---|---|---|
![]()  | 
isChanged | Indicates whether the value of the CompilationScheduleType property has changed. | 
![]()  | 
isPopulated | Indicates whether the Search scope compilation information has been reset to the default global values. | 
![]()  | 
lastRefreshTime | Represents the last time that the volatile Search scope compilation information was reset to the default global values. | 
![]()  | 
managedPropertiesById | Represents a key/value pair that stores the property IDs of the managed properties of the ScopesManager. | 
![]()  | 
managedPropertiesByName | Represents a key/value pair that stores the names of the managed properties of the ScopesManager. | 
Top
.gif)
.gif)
.gif)
.gif)
.gif)