FilterListBehavior Enumeration

Specifies how the row filter behaves.

Syntax

Visual Basic
C#

'Declaration
 
Public Enum FilterListBehavior 
   Inherits System.Enum

'Usage
 
Dim instance As FilterListBehavior

public enum FilterListBehavior : System.Enum

Members

Member	Description
Blank	[2] Displays the "(Blanks)" item in the drop-down list when appropriate
Custom	[0] Uses the custom filter
Default	[1031] Uses the default filter behavior, including Blank, NonBlank, and SortAlphabetically
DefaultFilter	[1024] Includes the DefaultFilterItem implementation of IFilterItem in the drop-down list
NonBlank	[4] Displays the "(NonBlanks)" item in the drop-down list when appropriate
SortAlphabetically	[1025] Uses the default filter behavior and sorts the drop-down list alphabetically
SortByLeastOccurrences	[1040] Sorts the drop-down list by the number of times an item occurs from least to most
SortByMostOccurrences	[1032] Sorts the drop-down list by the number of times an item occurs from most to least
SortNoSort	[1056] Uses the default filter behavior and does not perform a sort on the drop-down list.

Example

This example sets the filter list behavior.

FarPoint.Web.Spread.NamedStyle instyle = new FarPoint.Web.Spread.NamedStyle(); 
FarPoint.Web.Spread.NamedStyle outstyle = new FarPoint.Web.Spread.NamedStyle();
instyle.BackColor = Color.Yellow;
outstyle.BackColor = Color.Aquamarine; 
FarPoint.Web.Spread.FilterColumnDefinition fcd = new FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences | FarPoint.Web.Spread.FilterListBehavior.Default); 
FarPoint.Web.Spread.FilterColumnDefinition fcd1 = new FarPoint.Web.Spread.FilterColumnDefinition(2);
FarPoint.Web.Spread.FilterColumnDefinition fcd2 = new FarPoint.Web.Spread.FilterColumnDefinition();
FarPoint.Web.Spread.StyleRowFilter sf = new FarPoint.Web.Spread.StyleRowFilter(FpSpread1.Sheets[0], instyle, outstyle);
sf.AddColumn(fcd);
sf.AddColumn(fcd1); 
sf.AddColumn(fcd2);
FpSpread1.Sheets[0].RowFilter = sf;

Visual Basic

Dim instyle As New FarPoint.Web.Spread.NamedStyle()
Dim outstyle As New FarPoint.Web.Spread.NamedStyle()
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine
Dim fcd As New FarPoint.Web.Spread.FilterColumnDefinition(1, FarPoint.Web.Spread.FilterListBehavior.SortByMostOccurrences Or FarPoint.Web.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Web.Spread.FilterColumnDefinition(2)
Dim fcd2 As New FarPoint.Web.Spread.FilterColumnDefinition()
Dim sf As New FarPoint.Web.Spread.StyleRowFilter(FpSpread1.Sheets(0), instyle, outstyle)
sf.AddColumn(fcd) 
sf.AddColumn(fcd1)
sf.AddColumn(fcd2)
FpSpread1.Sheets(0).RowFilter = sf

Inheritance Hierarchy

System.Object
   System.ValueType
      System.Enum
         FarPoint.Web.Spread.FilterListBehavior

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

FarPoint.Web.Spread Namespace

User-Task Documentation

Customizing User Filtering of Data