AddIcon Method

Visual Basic
C#

'Declaration
 
Public Function AddIcon( _
   ByVal name As String, _
   ByVal icon As Icon _
) As Integer

'Usage
 
Dim instance As CustomIconContainer
Dim name As String
Dim icon As Icon
Dim value As Integer
 
value = instance.AddIcon(name, icon)

public int AddIcon( 
   string name,
   Icon icon
)

Parameters

name: Name of the icon object
icon: The icon object

Return Value

An int32 value that specifies the index of the object in the container. Returns -1 if there is an icon with the same name already in the container; in this case, the new icon object is not added.

This example uses a custom icon in the rule.

C#

System.Drawing.Icon resource1 = new System.Drawing.Icon("C:\\SpreadWin7\\SpWin7CSharp\\fpicon.ico");
System.Drawing.Icon resource2 = new System.Drawing.Icon("C:\\SpreadWin7\\SpWin7CSharp\\cat.ico");
fpSpread1.CustomIconContainer.AddIcon("fpicon", resource1);
fpSpread1.CustomIconContainer.AddIcon("cat", resource2);
FarPoint.Win.Spread.IconSetConditionalFormattingRule iconRule = new FarPoint.Win.Spread.IconSetConditionalFormattingRule(FarPoint.Win.Spread.ConditionalFormattingIconSetStyle.Custom);
iconRule.IconRuleSet.Add(new FarPoint.Win.Spread.ConditionalFormattingIconValue(0, FarPoint.Win.Spread.ConditionalFormattingValueType.Number, false, new FarPoint.Win.Spread.CustomImageInfo("fpicon")));
iconRule.IconRuleSet.Add(new FarPoint.Win.Spread.ConditionalFormattingIconValue(1, FarPoint.Win.Spread.ConditionalFormattingValueType.Number, false, new FarPoint.Win.Spread.CustomImageInfo("cat")));
fpSpread1_Sheet1.SetValue(0, 0, 0);
fpSpread1_Sheet1.SetValue(1, 0, 1);
fpSpread1_Sheet1.SetValue(2, 0, 2);
fpSpread1_Sheet1.SetConditionalFormatting(0, 0, 3, 1, new FarPoint.Win.Spread.IConditionalFormattingRule[] { iconRule });

VB.NET

Dim resource1 As New System.Drawing.Icon("C:\SpreadWin7\SpWin7CSharp\fpicon.ico")
Dim resource2 As New System.Drawing.Icon("C:\SpreadWin7\SpWin7CSharp\cat.ico")
FpSpread1.CustomIconContainer.AddIcon("fpicon", resource1)
FpSpread1.CustomIconContainer.AddIcon("cat", resource2)
Dim iconRule As New FarPoint.Win.Spread.IconSetConditionalFormattingRule(FarPoint.Win.Spread.ConditionalFormattingIconSetStyle.Custom)
iconRule.IconRuleSet.Add(New FarPoint.Win.Spread.ConditionalFormattingIconValue(0, FarPoint.Win.Spread.ConditionalFormattingValueType.Number, False, New FarPoint.Win.Spread.CustomImageInfo("fpicon")))
iconRule.IconRuleSet.Add(New FarPoint.Win.Spread.ConditionalFormattingIconValue(1, FarPoint.Win.Spread.ConditionalFormattingValueType.Number, False, New FarPoint.Win.Spread.CustomImageInfo("cat")))
FpSpread1_Sheet1.SetValue(0, 0, 0)
FpSpread1_Sheet1.SetValue(1, 0, 1)
FpSpread1_Sheet1.SetValue(2, 0, 2)
FpSpread1_Sheet1.SetConditionalFormatting(0, 0, 3, 1, New FarPoint.Win.Spread.IConditionalFormattingRule() {iconRule})

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

CustomIconContainer Class
CustomIconContainer Members