Spread Windows Forms 8.0 Product Documentation
GetCustomName(String,Int32,Int32) Method
Example 


Name, as a string
Base row index for calculating relative row references in the value
Base column index for calculating relative column references in the value
Gets the user-defined name, as a string, from the model.
Syntax
'Declaration
 
Overloads Function GetCustomName( _
   ByVal name As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer _
) As String
'Usage
 
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)
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.
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();
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 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

Reference

ICustomNameSupport Interface
ICustomNameSupport Members
Overload List

 

 


Copyright © GrapeCity, inc. All rights reserved.