ApplyIconFilter(Int32,FormatConditionIconSet,Nullable<Int32>) Method

Applies a IconFilter to the column.

Syntax

Visual Basic

'Declaration
 
Public Function ApplyIconFilter( _
   ByVal relativeColumnIndex As Integer, _
   ByVal iconSet As FormatConditionIconSet, _
   ByVal iconIndex As Nullable(Of Integer) _
) As IconFilter

C#

public IconFilter ApplyIconFilter( 
   int relativeColumnIndex,
   FormatConditionIconSet iconSet,
   Nullable<int> iconIndex
)

Parameters

relativeColumnIndex

A zero based column index relative to the Region

iconSet

The icon set containing the icon.

iconIndex

The zero-based index of the icon in the set or null for 'NoCellIcon'.

Exceptions

Exception	Description
System.ArgumentException	If the icon set is not valid.
System.IndexOutOfRangeException	If the index is less than zero or greater than or equal to the number of icons in the icon set..
System.InvalidOperationException	The Infragistics.Documents.Excel.WorksheetTable.IsFilterUIVisible value of the owning table is False. Filters cannot be applied when the header row or filter button is hidden.
System.InvalidOperationException	If column was removed from the table.
System.ArgumentOutOfRangeException	If the relativeColumnIndex is outside of the Region.
System.ComponentModel.InvalidEnumArgumentException	iconSet is not defined in the Infragistics.Documents.Excel.FormatConditionIconSet enumeration.

Requirements

Target Platforms: Windows 10, Windows 8.1, Windows 8, Windows 7, Windows Server 2012, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2