RankingModelFilterGenerator.GetRefinement method

Calculates the filters based on the refinement data.

Namespace:  Microsoft.Office.Server.Search.WebControls
Assembly:  Microsoft.Office.Server.Search (in Microsoft.Office.Server.Search.dll)

Syntax

'Declaration
Public Overrides Function GetRefinement ( _
    refinedData As Dictionary(Of String, Dictionary(Of String, RefinementDataElement)), _
    filterXml As XmlDocument, _
    maxFilterCats As Integer _
) As List(Of XmlElement)
'Usage
Dim instance As RankingModelFilterGenerator
Dim refinedData As Dictionary(Of String, Dictionary(Of String, RefinementDataElement))
Dim filterXml As XmlDocument
Dim maxFilterCats As Integer
Dim returnValue As List(Of XmlElement)

returnValue = instance.GetRefinement(refinedData, _
    filterXml, maxFilterCats)

public override List<XmlElement> GetRefinement(
    Dictionary<string, Dictionary<string, RefinementDataElement>> refinedData,
    XmlDocument filterXml,
    int maxFilterCats
)

Parameters

• refinedData
  Type: System.Collections.Generic.Dictionary<String, Dictionary<String, RefinementDataElement>>

  The refinement data based on which the filters are calculated.

• filterXml
  Type: System.Xml.XmlDocument

  The resulting filtered XML.

• maxFilterCats
  Type: System.Int32

  The maximum number of filter categories to generate.

Return value

Type: System.Collections.Generic.List<XmlElement>
A list of XML elements, each of which contains the filtered XML of a filter category.

Remarks

This override calculates the filters based on the refinement data.

This override returns null if the filter generator is not initialized, or the refinedData or filterXml parameter is null .

See also

Reference

RankingModelFilterGenerator class

RankingModelFilterGenerator members

Microsoft.Office.Server.Search.WebControls namespace