RefinementManager Members
Include Protected Members
Include Inherited Members
Configures the refinement calculation and merges different types of refinement filters before they are rendered in the Refinement Panel Web Part.
The RefinementManager type exposes the following members.
Properties
| Name | Description | |
|---|---|---|
.gif "Public property") |
AccuracyIndex | Gets or sets the number of results on which the refinement filters are calculated. |
|
DisplayCulture | Gets the culture used when the refinement filters are displayed. |
|
DisplayedCategories | Gets or sets the maximum number of filter categories to be displayed in the Refinement Web Panel Part. |
|
FilterCategories | Gets or sets the filter XML configuration that describes the filter categories of the Refinement Web Panel Part. |
|
FilterGenerators | Gets or sets a list of filter generators that parse the top Search results and recommend refinement filters for the Refinement Web Panel Part. |
|
IsInitialized | Gets a value that indicates whether the refinement manager has been initialized. |
|
Location | Gets or sets the federated location of the Search results. |
|
NumberOfCharsToDisplay | Gets or sets the maximum number of characters for the refinement filters to display in the Refinement Web Panel Part. |
|
ParentWebPart | Gets or sets the Refinement Web Part that configures and renders filters calculated by the refinement manager. |
|
QueryCulture | Gets the culture for the Search query. |
|
QueryNumber | Gets or sets the Cross-Web Part query identifier (ID) of the refinement manager. |
|
RefinementProperties | Gets the list of the properties based on which the refinement is configured. |
|
TotalResults | Gets or sets the total number of Search results returned by the query. |
|
UseDefaultConfiguration | Gets or sets a value that indicates whether the default filter category configuration should be used. |
Top
Methods
| Name | Description | |
|---|---|---|
.gif "Public method") |
AddDataToRefinement(String, String, Type) | Adds a property value to the refinement data for calculating the refinement filters. |
|
AddDataToRefinement(String, String, String, Int64) | Adds a property value to the refinement data for calculating the refinement filters. |
|
AddDataToRefinement(String, String, String, Int64, Single) | Adds a property value to the refinement data for calculating the refinement filters. |
.gif "Protected method") |
ConfigureCategories | Parses the filter XML configuration to a list of filter categories. |
|
Equals | (Inherited from Object.) |
|
Finalize | (Inherited from Object.) |
|
GetFilterCategoryById | Gets the filter category with the specified category identifier (ID). |
|
GetHashCode | (Inherited from Object.) |
.gif "Static member") |
GetInstance(Page) | Gets the instance of the refinement manager with the specified web page. |
|
GetInstance(Page, QueryId) | Gets the instance of the refinement manager with the specified web page and query identifier (ID). |
|
GetRefinementFilterGeneratorByFilterType | Creates a filter generator with the specified filter type. |
|
GetRefinementXml | Gets the final filtered XML document. |
|
GetRegisteredFilterGeneratorByFilterType | Gets the filter generator with the specified filter type. |
|
GetType | (Inherited from Object.) |
|
HasMoreResults | Checks whether the Search query has equal or more results than the Accuracy Index. |
|
Initialize | Initializes the refinement manager. |
|
IsRefinedProperty | Checks whether a property is used for refinement. |
|
MemberwiseClone | (Inherited from Object.) |
|
MergeFiltersFromGenerators | Merges the filters recommended by the filter generators to produce the final filtered XML document. |
|
PopulateRefinementProperties | Populates the list of properties that are refined on by the refinement manager. |
|
RegisterFilterGenerators | Creates the filter generators according to the filter configuration. |
|
ToString | (Inherited from Object.) |
Top