TaxonomyFilterGenerator.GetRefinement Method

Gets the refinement XML 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 TaxonomyFilterGenerator
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 from which the refinement XML is created.

• filterXml
  Type: System.Xml.XmlDocument

  The resulting filter XML to populate.

• maxFilterCats
  Type: System.Int32

  The maximum number of top filter categories to generate.

Return Value

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

Remarks

This override creates the XML that is used to construct the refinement panel.

See Also

Reference

TaxonomyFilterGenerator Class

TaxonomyFilterGenerator Members

Microsoft.Office.Server.Search.WebControls Namespace