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.
SortNumerically	[1088] Uses the default filter behavior and sorts the drop-down list numerically

Example

This example returns the row and column of the found text if it's in a cell.

FarPoint.Win.Spread.NamedStyle instyle = new FarPoint.Win.Spread.NamedStyle(); 
FarPoint.Win.Spread.NamedStyleim outstyle = new FarPoint.Win.Spread.NamedStyle(); 
instyle.BackColor = Color.Yellow; 
outstyle.BackColor = Color.Aquamarine; 
FarPoint.Win.Spread.FilterColumnDefinition fcd = new FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences
| FarPoint.Win.Spread.FilterListBehavior.Default); 
FarPoint.Win.Spread.FilterColumnDefinition fcd1 = new FarPoint.Win.Spread.FilterColumnDefinition(2); 
FarPoint.Win.Spread.FilterColumnDefinition fcd2 = new FarPoint.Win.Spread.FilterColumnDefinition(); 
FarPoint.Win.Spread.StyleRowFilter sf = new FarPoint.Win.Spread.StyleRowFilter(fpSpread1.ActiveSheet, instyle, outstyle);

sf.AddColumn(fcd); 
sf.AddColumn(fcd1); 
sf.AddColumn(fcd2); 
fpSpread1.ActiveSheet.RowFilter = sf;

Visual Basic

Dim instyle As New FarPoint.Win.Spread.NamedStyle
Dim outstyle As New FarPoint.Win.Spread.NamedStyle
instyle.BackColor = Color.Yellow
outstyle.BackColor = Color.Aquamarine
Dim fcd As New FarPoint.Win.Spread.FilterColumnDefinition(1, FarPoint.Win.Spread.FilterListBehavior.SortByMostOccurrences
Or FarPoint.Win.Spread.FilterListBehavior.Default)
Dim fcd1 As New FarPoint.Win.Spread.FilterColumnDefinition(2)
Dim fcd2 As New FarPoint.Win.Spread.FilterColumnDefinition

Dim sf As New FarPoint.Win.Spread.StyleRowFilter(fpSpread1.ActiveSheet, instyle, outstyle)
sf.AddColumn(fcd)
sf.AddColumn(fcd1)
sf.AddColumn(fcd2)
fpSpread1.ActiveSheet.RowFilter = sf

Inheritance Hierarchy

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

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

FarPoint.Win.Spread Namespace
ListBehavior Property (FilterColumnDefinition Class)

User-Task Documentation

Customizing the List of Filter Items