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


name
Name, as a 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

Gets the user-defined name, as a string, from the model.

Syntax

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

Parameters

name
Name, as a 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

Return Value

String containing the custom name

Example

This example returns the expression value for a custom name.
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);
label1.Text = "The type of the custom name is " + cns.GetCustomName("ALPHA", 1, 1).ToString();
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)
Label1.Text = "The type of the custom name is " & cns.GetCustomName("ALPHA", 1, 1).ToString()

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.