Spread Windows Forms 7.0 Product Documentation
AddModelScopeCustomName(String,String,Int32,Int32,String) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.Model Namespace > DefaultSheetDataModel Class > AddModelScopeCustomName Method : AddModelScopeCustomName(String,String,Int32,Int32,String) Method


name
Name of the expression to add (used in formulas to reference the value)
value
Value of the expression (used in formulas for evaluation)
baseRow
Base row index for computing relative cell references
baseColumn
Base column index for computing relative cell references
comment
Comment of the expression (used in formulas to display information)

Glossary Item Box

Adds a custom name to the model scope.

Syntax

Visual Basic (Declaration) 
Public Overloads Sub AddModelScopeCustomName( _
   ByVal name As String, _
   ByVal value As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer, _
   ByVal comment As String _
) 
Visual Basic (Usage)Copy Code
Dim instance As DefaultSheetDataModel
Dim name As String
Dim value As String
Dim baseRow As Integer
Dim baseColumn As Integer
Dim comment As String
 
instance.AddModelScopeCustomName(name, value, baseRow, baseColumn, comment)
C# 
public void AddModelScopeCustomName( 
   string name,
   string value,
   int baseRow,
   int baseColumn,
   string comment
)

Parameters

name
Name of the expression to add (used in formulas to reference the value)
value
Value of the expression (used in formulas for evaluation)
baseRow
Base row index for computing relative cell references
baseColumn
Base column index for computing relative cell references
comment
Comment of the expression (used in formulas to display information)

Example

This example uses the AddModelScopeCustomName method.
C#Copy Code
FarPoint.Win.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(5, 5);
dataModel.AddModelScopeCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1, "test");
dataModel.SetFormula(1, 1, "TWICESUM");
dataModel.SetValue(0, 0, 10);
dataModel.SetValue(1, 0, 10);
fpSpread1.ActiveSheet.Models.Data = dataModel;
VB.NETCopy Code
Dim dataModel As New FarPoint.Win.Spread.Model.DefaultSheetDataModel(10, 10)
dataModel.AddModelScopeCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1, "test")
dataModel.SetFormula(1, 1, "TWICESUM")
dataModel.SetValue(0, 0, 10)
dataModel.SetValue(1, 0, 10)
FpSpread1.ActiveSheet.Models.Data = dataModel

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

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.