RefinementManager 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
Public property AccuracyIndex Gets or sets the number of results on which the refinement filters are calculated.
Public property DisplayCulture Gets the culture used when the refinement filters are displayed.
Public property DisplayedCategories Gets or sets the maximum number of filter categories to be displayed in the Refinement Web Panel Part.
Public property FilterCategories Gets or sets the filter XML configuration that describes the filter categories of the Refinement Web Panel Part.
Public property 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.
Public property IsInitialized Gets a value that indicates whether the refinement manager has been initialized.
Public property Location Gets or sets the federated location of the Search results.
Public property NumberOfCharsToDisplay Gets or sets the maximum number of characters for the refinement filters to display in the Refinement Web Panel Part.
Public property ParentWebPart Gets or sets the Refinement Web Part that configures and renders filters calculated by the refinement manager.
Public property QueryCulture Gets the culture for the Search query.
Public property QueryNumber Gets or sets the Cross-Web Part query identifier (ID) of the refinement manager.
Public property RefinementProperties Gets the list of the properties based on which the refinement is configured.
Public property TotalResults Gets or sets the total number of Search results returned by the query.
Public property UseDefaultConfiguration Gets or sets a value that indicates whether the default filter category configuration should be used.

Top

Methods

  Name Description
Public method AddDataToRefinement(String, String, Type) Adds a property value to the refinement data for calculating the refinement filters.
Public method AddDataToRefinement(String, String, String, Int64) Adds a property value to the refinement data for calculating the refinement filters.
Public method AddDataToRefinement(String, String, String, Int64, Single) Adds a property value to the refinement data for calculating the refinement filters.
Protected method ConfigureCategories Parses the filter XML configuration to a list of filter categories.
Public method Equals (Inherited from Object.)
Protected method Finalize (Inherited from Object.)
Public method GetFilterCategoryById Gets the filter category with the specified category identifier (ID).
Public method GetHashCode (Inherited from Object.)
Public methodStatic member GetInstance(Page) Gets the instance of the refinement manager with the specified web page.
Public methodStatic member GetInstance(Page, QueryId) Gets the instance of the refinement manager with the specified web page and query identifier (ID).
Protected method GetRefinementFilterGeneratorByFilterType Creates a filter generator with the specified filter type.
Public method GetRefinementXml Gets the final filtered XML document.
Public method GetRegisteredFilterGeneratorByFilterType Gets the filter generator with the specified filter type.
Public method GetType (Inherited from Object.)
Public method HasMoreResults Checks whether the Search query has equal or more results than the Accuracy Index.
Public method Initialize Initializes the refinement manager.
Public method IsRefinedProperty Checks whether a property is used for refinement.
Protected method MemberwiseClone (Inherited from Object.)
Protected method MergeFiltersFromGenerators Merges the filters recommended by the filter generators to produce the final filtered XML document.
Protected method PopulateRefinementProperties Populates the list of properties that are refined on by the refinement manager.
Protected method RegisterFilterGenerators Creates the filter generators according to the filter configuration.
Public method ToString (Inherited from Object.)

Top

See also

Reference

RefinementManager class

Microsoft.Office.Server.Search.WebControls namespace