Note

If you are connecting a CMSAbstractQueryFilterControl filter to a data source with a custom query, the query must contain the ##WHERE## and ##ORDERBY## expressions. When applied, the filter replaces the expressions with dynamically generated SQL code.

Query example:

<%@ Control Language="C#" AutoEventWireup="true" CodeFile="CustomProductFilter.ascx.cs" Inherits="CMSGlobalFiles_CustomProductFilter" %>
 
<table cellpadding="2">
<tr>
  <td>
    <cms:LocalizedLabel ID="lblDepartment" runat="server" Text="Product department" DisplayColon="true">
    </cms:LocalizedLabel>
  </td>
  <td>
    <cms:LocalizedDropDownList ID="drpDepartment" runat="server" Width="180" >
    </cms:LocalizedDropDownList>
  </td>
</tr>
<tr>
  <td>
    <cms:LocalizedLabel ID="lblOrder" runat="server" Text="Order by" DisplayColon="true">
    </cms:LocalizedLabel>
  </td>
  <td>
    <cms:LocalizedDropDownList ID="drpOrder" runat="server" Width="180" >
    </cms:LocalizedDropDownList>
  </td>
</tr>
<tr>
  <td colspan="2">
    <cms:LocalizedButton ID="btnFilter" runat="server" Text="Apply Filter" />
  </td>
</tr>
</table>

using System;
using System.Data;
using System.Collections.Generic;
using System.Web;
using System.Web.UI;
using System.Web.UI.WebControls;
 
using CMS.Controls;
using CMS.GlobalHelper;
using CMS.Ecommerce;
 
public partial class CMSGlobalFiles_CustomProductFilter : CMSAbstractDataFilterControl
{
 
   ...
 
}

/// <summary>
/// Setup the inner child controls
/// </summary>
private void SetupControl()
{
    // Hide the filter if StopProcessing is enabled
    if (this.StopProcessing)
    {
        this.Visible = false;
    }

 
    // Initialize only if the current request is NOT a postback
    else if (!RequestHelper.IsPostBack())
    {
        // Loads product departments as filtering options
        InitializeDepartments();

 
        // Initialize the order by drop-down list
        IntializeOrder();
    }
}

 
 
/// <summary>
/// Ensures that the ordering options are loaded into the order by drop-down list
/// </summary>
private void IntializeOrder()
{
    // Initialize options
    this.drpOrder.Items.Add(new ListItem("Price - Ascending", "priceAsc"));
    this.drpOrder.Items.Add(new ListItem("Price - Descending", "priceDesc"));
    this.drpOrder.Items.Add(new ListItem("Product name", "name"));
}

 
 
/// <summary>
/// Loads all existing product departments as filtering options into the department drop-down list
/// </summary>
private void InitializeDepartments()
{
  // Get all product departments
  DataSet departments = DepartmentInfoProvider.GetDepartments("", "DepartmentDisplayName", 0, "DepartmentID, DepartmentDisplayName");

 
    // Check if there are any product departments
    if (!DataHelper.DataSourceIsEmpty(departments))
    {
        // Binds departments to the drop-down list
        this.drpDepartment.DataSource = departments;
        this.drpDepartment.DataTextField = "DepartmentDisplayName";
        this.drpDepartment.DataValueField = "DepartmentID";

 
        this.drpDepartment.DataBind();

 
        // Adds the default '(all)' value
        this.drpDepartment.Items.Insert(0, new ListItem("(all)", "##ALL##"));
    }
}

/// <summary>
/// Generates a WHERE condition and ORDER BY clause based on the current filtering selection
/// </summary>
private void SetFilter()
{
  string where = null;
  string order = null;

 
  // Generate a WHERE condition based on the selected product department
  if (this.drpDepartment.SelectedValue != null)
   {
      int departmentId = ValidationHelper.GetInteger(this.drpDepartment.SelectedValue, 0);

 
        if (departmentId > 0)
        {
            where = "SKUDepartmentID = " + departmentId;
        }
    }

 
    // Apply the selected ordering direction        
    if (this.drpOrder.SelectedValue != "")
    {
        switch (this.drpOrder.SelectedValue)
        {
            case "priceAsc":
                order = "SKUPrice";
                break;

 
            case "priceDesc":
                order = "SKUPrice Desc";
                break;

 
            case "name":
                order = "SKUName";
                break;
        }
    }

 
    if (where != null)
    {
        // Set where condition
        this.WhereCondition = where;
    }
 
    if (order != null)
    {
        // Set orderBy clause
        this.OrderBy = order;
    }
 
    // Raise the filter changed event
    this.RaiseOnFilterChanged();
}

/// <summary>
/// Init event handler
/// </summary>
protected override void OnInit(EventArgs e)
{
    // Create child controls
    SetupControl();

 
    base.OnInit(e);
}
 
 
/// <summary>
/// PreRender event handler
/// </summary>
protected override void OnPreRender(EventArgs e)
{
    // Check if the current request is a postback
    if (RequestHelper.IsPostBack())
    {
        // Apply the filter to the displayed data
        SetFilter();
    }

 
    base.OnPreRender(e);
}

Web part

Instructions

Documents data source

1.Configure the web part to load product documents.

2.Fill in the Filter name property (e.g. CustomProductFilter).

Note: You can alternatively use the Products data source web part for this purpose.

Filter

1.Assign a Filter name that matches the data source (CustomProductFilter).

2.Enter the path of the .ascx file implementing your custom filter into the Filter control path property (~/CMSGlobalFiles/CustomProductFilter.ascx).

Basic repeater

1.Enter the ID of the Documents data source web part into the Data source name property.

2.Set an appropriate Transformation name, for example: Ecommerce.Transformations.Product_SimplePreview