FileManagerDetailsViewCustomColumnHeaderFilterFillItemsEventArgs.AddValue(String, String) Method

Adds a new filter item to the column header filter.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v24.1.dll

NuGet Package: DevExpress.Web

Declaration

C#

public void AddValue(
    string displayText,
    string value
)

VB.NET

Public Sub AddValue(
    displayText As String,
    value As String
)

Parameters

Name	Type	Description
displayText	String	A String value that specifies the filter item’s display text.
value	String	A String value that specifies the filter item’s value.

Remarks

This method uses the equality operator to compare values. To provide your own filter criteria, use the AddValue method’s overload with the query parameter.

To learn more about custom columns, see the Custom Columns topic.

Example

This code sample demonstrates how to populate a custom column’s header filter with custom items. For this purpose, the ASPxFileManager.DetailsViewCustomColumnHeaderFilterFillItems event is handled.

WebForm1.aspx

<dx:ASPxFileManager ID="ASPxFileManager1" runat="server" Width="800px" Height="400px" OnDetailsViewCustomColumnDisplayText="ASPxFileManager1_DetailsViewCustomColumnDisplayText" OnDetailsViewCustomColumnHeaderFilterFillItems="ASPxFileManager1_DetailsViewCustomColumnHeaderFilterFillItems">
    <Settings RootFolder="~\Files\" ThumbnailFolder="~\Thumb\" />
    <SettingsFileList View="Details">
        <DetailsViewSettings>
            <Columns>
                <dx:FileManagerDetailsColumn Caption=" " FileInfoType="Thumbnail" VisibleIndex="0">
                </dx:FileManagerDetailsColumn>
                <dx:FileManagerDetailsColumn Caption="Name" VisibleIndex="1">
                </dx:FileManagerDetailsColumn>
                <dx:FileManagerDetailsCustomColumn Caption="Extension" Name="FileExtension" VisibleIndex="2" ShowHeaderFilterButton="True">
                </dx:FileManagerDetailsCustomColumn>
            </Columns>
        </DetailsViewSettings>
    </SettingsFileList>
</dx:ASPxFileManager>

WebForm1.aspx.cs

protected void ASPxFileManager1_DetailsViewCustomColumnHeaderFilterFillItems(object source, DevExpress.Web.FileManagerDetailsViewCustomColumnHeaderFilterFillItemsEventArgs e) {
    if (e.Column.Name != "FileExtension") return;
    e.Values.Clear();
    e.AddShowAll();
    e.AddValue("Media Files", string.Empty, "FileExtension = 'avi' or FileExtension = 'mp3' or FileExtension = 'jpg'");
    e.AddValue("Documents", string.Empty, "FileExtension = 'txt' or FileExtension = 'rtf' or FileExtension = 'xml'");
    e.AddValue("Photos", "jpg");
}

WebForm1.aspx.vb

Protected Sub ASPxFileManager1_DetailsViewCustomColumnHeaderFilterFillItems(ByVal source As Object, ByVal e As DevExpress.Web.FileManagerDetailsViewCustomColumnHeaderFilterFillItemsEventArgs)
    If e.Column.Name <> "FileExtension" Then
        Return
    End If
    e.Values.Clear()
    e.AddShowAll()
    e.AddValue("Media Files", String.Empty, "FileExtension = 'avi' or FileExtension = 'mp3' or FileExtension = 'jpg'")
    e.AddValue("Documents", String.Empty, "FileExtension = 'txt' or FileExtension = 'rtf' or FileExtension = 'xml'")
    e.AddValue("Photos", "jpg")
End Sub