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


name
Custom name to get
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value
SheetviewSCope

Glossary Item Box

Gets the string value for a custom name on this sheet from the model.

Syntax

Visual Basic (Declaration) 
Public Overloads Function GetCustomName( _
   ByVal name As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer, _
   ByVal SheetviewSCope As Boolean _
) As String
Visual Basic (Usage)Copy Code
Dim instance As SheetView
Dim name As String
Dim baseRow As Integer
Dim baseColumn As Integer
Dim SheetviewSCope As Boolean
Dim value As String
 
value = instance.GetCustomName(name, baseRow, baseColumn, SheetviewSCope)
C# 
public string GetCustomName( 
   string name,
   int baseRow,
   int baseColumn,
   bool SheetviewSCope
)

Parameters

name
Custom name to get
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value
SheetviewSCope

Example

This example uses the GetCustomName method.
C#Copy Code
fpSpread1.ActiveSheet.AddCustomName("Alpha", new FarPoint.CalcEngine.DoubleExpression(20), false, "Extra information");
fpSpread1.ActiveSheet.SetFormula(1, 1, "Alpha");
listBox1.Items.Add(fpSpread1.ActiveSheet.GetCustomName("Alpha", false));
listBox1.Items.Add(fpSpread1.ActiveSheet.GetCustomName("Alpha", 0, 0, false));
listBox1.Items.Add(fpSpread1.ActiveSheet.GetCustomNameComment("Alpha", false));
VB.NETCopy Code
FpSpread1.ActiveSheet.AddCustomName("Alpha", New FarPoint.CalcEngine.DoubleExpression(20), False, "Extra information")
FpSpread1.ActiveSheet.SetFormula(1, 1, "Alpha")
ListBox1.Items.Add(FpSpread1.ActiveSheet.GetCustomName("Alpha", False))
ListBox1.Items.Add(FpSpread1.ActiveSheet.GetCustomName("Alpha", 0, 0, False))
ListBox1.Items.Add(FpSpread1.ActiveSheet.GetCustomNameComment("Alpha", False))

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.