Refinement Panel XML Schema

Applies to: SharePoint Server 2010

The Refinement Panel Web Part provides a summary of search results and enables users to filter results, for example, by kind of content (such as document, spreadsheet, presentation, or Web page), content location (such as SharePoint sites), content author, or date last modified. The Refinement Panel XML schema defines the structure of the XML that specifies the filter categories for the Web Part.

Schema

<FilterCategories>
    <Category
        Title="string"
        Description="string"
        Type="TypeName"
        MappedProperty="PropertyName"
        MetadataThreshhold="value"
        NumberOfFiltersToDisplay="value"
        MaxNumberOfFilters="value"
        SortBy="Frequency|NumericValue|Name|Custom"
        SortDirection="Descending|Ascending"
        SortByForMoreFilters="Frequency|NumericValue|Name|Custom"
        SortDirectionForMoreFilters="Descending|Ascending"
        ShowMoreLink="True|False"
        MoreLinkText="string"
        LessLinkText="string"
        ShowCounts="Count|Percentage">
            <CustomFilters 
                MappingType="ValueMapping|RangeMapping" 
                DataType="Date|Numeric|String" 
                ValueReference="Relative|Absolute" 
                ShowAllInMore="True|False">
                <CustomFilter CustomValue="string">
                    <OriginalValue></OriginalValue>
                </CustomFilter>
            </CustomFilters>
    </Category>
</FilterCategories>

Elements

Name	Description
FilterCategories [Refinement]	Specifies the top-level node of the refinement filter category definition.
Category [Refinement]	Specifies the filter category for the custom refinement filters.
CustomFilters [Refinement]	Contains the custom refinement filters for the category.
CustomFilter [Refinement]	Specifies a custom refinement filter.
OriginalValue [Refinement]	Specifies the absolute or relative value from the managed property for the custom refinement filter.

See Also

Reference

RefinementWebPart

Concepts

Refinement Panel Overview