Version

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

Applies a IconFilter to the column.
Syntax
'Declaration
 
Public Function ApplyIconFilter( _
   ByVal relativeColumnIndex As System.Integer, _
   ByVal iconSet As FormatConditionIconSet, _
   ByVal iconIndex As System.Nullable(Of Integer) _
) As IconFilter
public IconFilter ApplyIconFilter( 
   System.int relativeColumnIndex,
   FormatConditionIconSet iconSet,
   System.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
ExceptionDescription
System.ArgumentExceptionIf the icon set is not valid.
System.IndexOutOfRangeExceptionIf the index is less than zero or greater than or equal to the number of icons in the icon set..
System.InvalidOperationExceptionThe 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.InvalidOperationExceptionIf column was removed from the table.
System.ArgumentOutOfRangeExceptionIf the relativeColumnIndex is outside of the Region.
System.ComponentModel.InvalidEnumArgumentExceptioniconSet is not defined in the Infragistics.Documents.Excel.FormatConditionIconSet enumeration.
Requirements

Target Platforms: Windows 8.1, Windows 8.1, Windows 8, Windows 7, 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

See Also

View on GitHub