AddCustomName(String,String,Int32,Int32) Method

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

Syntax

Visual Basic
C#

'Declaration
 
Overloads Sub AddCustomName( _
   ByVal name As String, _
   ByVal value As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer _
)

'Usage
 
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)

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.

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 Basic

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 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

Reference

ICustomNameSupport Interface
ICustomNameSupport Members
Overload List