FileManagerDetailsCustomColumn.ShowHeaderFilterButton Property

Specifies whether a header filter button is displayed for the custom column.

Namespace: DevExpress.Web

Assembly: DevExpress.Web.v18.2.dll

Declaration

C#

[DefaultValue(DefaultBoolean.Default)]
public DefaultBoolean ShowHeaderFilterButton { get; set; }

VB.NET

<DefaultValue(DefaultBoolean.Default)>
Public Property ShowHeaderFilterButton As DefaultBoolean

Property Value

Type	Default	Description
DefaultBoolean	**Default**	true to display a header filter button; otherwise false.

Available values:

Name	Description
True	Corresponds to a Boolean value of true.
False	Corresponds to a Boolean value of false.
Default	The value is determined by the current object’s parent object setting (e.g., a control setting).

Remarks

Use the ShowHeaderFilterButton property to specify a custom column’s header filter availability. If the property is set to Default, the header filter availability is defined by the FileManagerFileListDetailsViewSettings.ShowHeaderFilterButton property.

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.

Note

A complete sample project is available at https://github.com/DevExpress-Examples/aspxfilemanager-how-to-implement-a-custom-column-and-provide-it-with-a-custom-header-filter-t220483

WebForm1.aspx (C#)

<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

WebForm1.aspx (VB.NET)

<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>