GetCustomNameEnumerator Method (DefaultSheetDataModel)

Gets an IEnumerator that enumerates through the names of the named expressions in the model.

Syntax

Visual Basic
C#

'Declaration
 
Public Function GetCustomNameEnumerator() As IEnumerator

'Usage
 
Dim instance As DefaultSheetDataModel
Dim value As IEnumerator
 
value = instance.GetCustomNameEnumerator()

public IEnumerator GetCustomNameEnumerator()

Return Value

IEnumerator object containing the enumerator for the custom name

Example

This example illustrates the use of this member by returning an IEnumerator that enumerates through the names of the named expressions in the model.

FarPoint.Win.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(10, 10);
dataModel.AddCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1);
dataModel.AddCustomName("TwiceProduct", "2*A1*A2", 2, 2);
dataModel.SetFormula(1, 1, "TWICESUM");
dataModel.SetFormula(2, 2, "TwiceProduct");
dataModel.SetValue(0, 0, 10);
dataModel.SetValue(1, 0, 10);
fpSpread1.ActiveSheet.Models.Data = dataModel;

IEnumerator enm;
enm = dataModel.GetCustomNameEnumerator();
while (enm.MoveNext())
{
listBox1.Items.Add(enm.Current);
}

Visual Basic

Dim dataModel As New FarPoint.Win.Spread.Model.DefaultSheetDataModel(10, 10)
dataModel.AddCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1)
dataModel.AddCustomName("TwiceProduct", "2*A1*A2", 2, 2)
dataModel.SetFormula(1, 1, "TWICESUM")
dataModel.SetFormula(2, 2, "TwiceProduct")
dataModel.SetValue(0, 0, 10)
dataModel.SetValue(1, 0, 10)
FpSpread1.ActiveSheet.Models.Data = dataModel

Dim enm As IEnumerator
enm = dataModel.GetCustomNameEnumerator()
While enm.MoveNext()
ListBox1.Items.Add(enm.Current)
End While

Requirements

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

Reference

DefaultSheetDataModel Class
DefaultSheetDataModel Members