Spread Windows Forms 8.0 Product Documentation
GetCustomNameEnumerator Method (ICustomNameSupport)
Example 


Gets an IEnumerator that enumerates through the custom names defined in the model.
Syntax
'Declaration
 
Function GetCustomNameEnumerator() As IEnumerator
'Usage
 
Dim instance As ICustomNameSupport
Dim value As IEnumerator
 
value = instance.GetCustomNameEnumerator()
IEnumerator GetCustomNameEnumerator()

Return Value

IEnumerator containing the enumerator for the custom name
Example
This example enumerates through the custom names.
System.Collections.IEnumerator se;
FarPoint.Win.Spread.Model.ICustomNameSupport cns;
cns = (FarPoint.Win.Spread.Model.ICustomNameSupport)fpSpread1.ActiveSheet.Models.Data;
cns.AddCustomName("ALPHA", "SUM(A1,A2)", 1, 1);
cns.AddCustomName("GAMMA", "A1*A2", 2, 2);
fpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA");
fpSpread1.ActiveSheet.SetFormula(2, 2, "GAMMA");
fpSpread1.ActiveSheet.SetValue(0, 0, 10);
fpSpread1.ActiveSheet.SetValue(1, 0, 10);
se = cns.GetCustomNameEnumerator();
listBox1.Items.AddRange(new Object[] {se.MoveNext().ToString(), se.Current.ToString(), se.MoveNext().ToString(), se.Current.ToString()});
Dim se As System.Collections.IEnumerator
Dim cns As FarPoint.Win.Spread.Model.ICustomNameSupport
cns = FpSpread1.ActiveSheet.Models.Data
cns.AddCustomName("ALPHA", "SUM(A1,A2)", 1, 1)
cns.AddCustomName("GAMMA", "A1*A2", 2, 2)
FpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA")
FpSpread1.ActiveSheet.SetFormula(2, 2, "GAMMA")
FpSpread1.ActiveSheet.SetValue(0, 0, 10)
FpSpread1.ActiveSheet.SetValue(1, 0, 10)
se = cns.GetCustomNameEnumerator()
ListBox1.Items.AddRange(New Object() {se.MoveNext().ToString(), se.Current().ToString(), se.MoveNext().ToString(), se.Current().ToString()})
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

See Also

Reference

ICustomNameSupport Interface
ICustomNameSupport Members

 

 


Copyright © GrapeCity, inc. All rights reserved.