Spread Windows Forms 6.0 Product Documentation
AddCustomName(String,String,Int32,Int32) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.Model Namespace > ICustomNameSupport Interface > AddCustomName Method : AddCustomName(String,String,Int32,Int32) Method


name
Name to add
value
Value for name, as string
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value

Glossary Item Box

Adds a new user-defined name for the specified value, as string, to the model.

Syntax

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

Parameters

name
Name to add
value
Value for name, as string
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value

Example

This example adds a named expression to the sheet for use in formulas.
C#Copy Code
FarPoint.Win.Spread.Model.ICustomNameSupport cns;
cns = (FarPoint.Win.Spread.Model.ICustomNameSupport)fpSpread1.ActiveSheet.Models.Data;
cns.AddCustomName("ALPHA", "SUM(A1,A2)", 1, 1);
fpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA");
fpSpread1.ActiveSheet.SetValue(0, 0, 10);
fpSpread1.ActiveSheet.SetValue(1, 0, 10);
Visual BasicCopy Code
Dim cns As FarPoint.Win.Spread.Model.ICustomNameSupport
cns = FpSpread1.ActiveSheet.Models.Data
cns.AddCustomName("ALPHA", "SUM(A1,A2)", 1, 1)
FpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA")
FpSpread1.ActiveSheet.SetValue(0, 0, 10)
FpSpread1.ActiveSheet.SetValue(1, 0, 10)

Requirements

Target Platforms: 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

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