GetFilterColumnDefinition Method (DefaultRowFilter)

Gets the filter column definition from the specified column.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetFilterColumnDefinition( _
   ByVal columnIndex As Integer _
) As FilterColumnDefinition

'Usage
 
Dim instance As DefaultRowFilter
Dim columnIndex As Integer
Dim value As FilterColumnDefinition
 
value = instance.GetFilterColumnDefinition(columnIndex)

public FilterColumnDefinition GetFilterColumnDefinition( 
   int columnIndex
)

Parameters

columnIndex: Column index

Return Value

FilterColumnDefinition object containing the filter column definition

Example

This example gets the display name for the column definition.

fpSpread1.ActiveSheet.Columns[0].AllowAutoFilter = true;
Dim fcd As FarPoint.Win.Spread.FilterColumnDefinition = fpSpread1.ActiveSheet.RowFilter.GetFilterColumnDefinition(0)
MessageBox.Show(fcd.Filters[0].DisplayName);

Visual Basic

FpSpread1.ActiveSheet.Columns(0).AllowAutoFilter = True
Dim fcd As FarPoint.Win.Spread.FilterColumnDefinition = FpSpread1.ActiveSheet.RowFilter.GetFilterColumnDefinition(0)
MessageBox.Show(fcd.Filters(0).DisplayName)

Requirements

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

Reference

DefaultRowFilter Class
DefaultRowFilter Members