FilterControl

FilterControl provides dynamic catalog characteristic filters for supported listing controls. The legacy source identifies use with CatalogItemTileListingControl and DataDisplayControl.

Filter availability

A filter appears only when at least two options are available. Use MinimumToShow to configure the threshold.

The legacy source warns that dynamic filtering can return fewer than the configured number of unique results. Test the configured listing and hide the filter when it does not provide useful choices.

Configurable properties

Property	Default	Valid values or format	Effect
MinimumToShow Integer	Not specified		Sets the minimum available options required to display a filter.
FilterType String	Not specified		Sets the rendering mode for characteristic-type colors.
DataControlID String	Not specified		Sets the associated data control identifier.
HeaderText String	Not specified		Sets the filter header text.
HideOnEmpty Boolean	Not specified	true, false	Controls whether the filter is hidden when no values are available.
IsFiltering Boolean	Not specified	true, false	Indicates whether filtering is active.
ItemCountFormat String	Not specified		Sets the item-count display format.
SelectionText String	Not specified		Sets the selection text.
ShowItemCount Boolean	Not specified	true, false	Controls whether item counts appear.
TextField String	Not specified		Sets the field used for filter text.
ColorTileClearFilterText String	Not specified		Sets the clear-filter text for color tiles.
ColorTileCSSClass String	Not specified		Sets the color-tile CSS class.
ColorTileHeaderCSSClass String	Not specified		Sets the color-tile header CSS class.
ColorTilePanelCSSClass String	Not specified		Sets the color-tile panel CSS class.
ColorTileHeight Integer	Not specified		Sets the color-tile height.
ColorTileWidth Integer	Not specified		Sets the color-tile width.
ListClearFilterText String	Not specified		Sets the clear-filter text for list rendering.

SitePages.config example

The following example loads FilterControl.ascx and applies the documented literal defaults. The following properties are omitted because they do not have documented literal defaults: MinimumToShow, FilterType, DataControlID, HeaderText, HideOnEmpty, IsFiltering, ItemCountFormat, SelectionText, ShowItemCount, TextField, ColorTileClearFilterText, ColorTileCSSClass, ColorTileHeaderCSSClass, ColorTilePanelCSSClass, ColorTileHeight, ColorTileWidth, ListClearFilterText.

<Control src="FilterControl.ascx" />

Add this <Control> element to the appropriate page placeholder as described in The SitePages.config File.

Color filter modes

For characteristic-type colors, FilterType supports the following rendering modes.

Filter type	Behavior
ColorTiles	Displays selectable color blocks without the HTML color value or item count.
ColorList	Displays the color in a standard list with the HTML color value.
ColorDropDown	Displays the color in a standard drop-down with the HTML color value.

Inherited properties

FilterControl inherits shared visibility and shopper-access conditions from CyberStoreBaseControl.

Validate the control

1. Configure a supported listing control with filterable characteristics.
2. Confirm the filter is hidden below the configured minimum option threshold.
3. Test each configured color filter mode.
4. Confirm the resulting listing remains useful when multiple filters are applied.