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


name
Custom name to add
value
String value for the custom name
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 custom name to the model using the specified string value.

Syntax

Visual Basic (Declaration) 
Public 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 SheetView
Dim name As String
Dim value As String
Dim baseRow As Integer
Dim baseColumn As Integer
 
instance.AddCustomName(name, value, baseRow, baseColumn)
C# 
public void AddCustomName( 
   string name,
   string value,
   int baseRow,
   int baseColumn
)

Parameters

name
Custom name to add
value
String value for the custom name
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value

Remarks

Custom names are identifiers to represent information in the spreadsheet. A custom name can refer to a cell, a range of cells, a computed value, or a formula. Methods that deal with custom names provide the same functionality as the Name in Microsoft Excel.

The name can contain up to 255 characters and can include letters, numbers, or underscores. The first character must be a letter or an underscore.

For more information on on using custom names in formulas, refer to the Formula Reference.

Example

This example illustrates the use of this member by returning the expression value for a custom name from the sheet.
C#Copy Code
FarPoint.CalcEngine.Expression ex; 
fpSpread1.ActiveSheet.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);
ex = fpSpread1.ActiveSheet.GetCustomName("Alpha");
label1.Text = ex.ToString();
Visual BasicCopy Code
Dim ex As FarPoint.CalcEngine.Expression
FpSpread1.ActiveSheet.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)
ex = FpSpread1.ActiveSheet.GetCustomName("Alpha")
Label1.Text = ex.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

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