The requested page is not available for the requested platform. You are viewing the content for Default platform.

FilterController.SetFilterAction Property

Provides access to the ModificationsController's SetFilter Action.

Namespace: DevExpress.ExpressApp.SystemModule

Assembly: DevExpress.ExpressApp.v19.1.dll

Declaration

public SingleChoiceAction SetFilterAction { get; }
Public ReadOnly Property SetFilterAction As SingleChoiceAction

Property Value

Type Description
SingleChoiceAction

A SingleChoiceAction object representing the Filter Action.

Remarks

The SetFilter Action is intended to apply one of the predefined filters to the current List View:

In a Windows Forms application:

Filters_Win_2

In an ASP.NET application:

Filters_Web_2

The predefined filters represent the elements of the Filter Action's Items collection (see ChoiceActionBase.Items). This collection's elements are generated using information from the Application Model's Views | <ListView> | Filters node. To add filters to this node, use the Model Editor, or do it in code. For details, refer to the Filters Application Model Node and ListViewFilterAttribute topics.

The SetFilter Action is active when the FilterController is active. To ascertain why the SetFilter Action is currently deactivated or disabled, use the DiagnosticInfo Action. If you need to change the Action's "active" or "enabled" state in code, use its ActionBase.Active or ActionBase.Enabled property, respectively. To change the "visible" or "enabled" state of the Filter Action's items, use their ChoiceActionItem.Active and ChoiceActionItem.Enabled properties, respectively.

Information on the SetFilter Action is available in the Application Model's ActionDesign node. To access it, use the Model Editor.

See Also