GetCustomName(String) Method

Gets the user-defined name, as an expression, in the model.

Syntax

Visual Basic
C#

'Declaration
 
Overloads Function GetCustomName( _
   ByVal name As String _
) As Expression

'Usage
 
Dim instance As ICustomNameSupport
Dim name As String
Dim value As Expression
 
value = instance.GetCustomName(name)

Expression GetCustomName( 
   string name
)

Parameters

name: Name, as an expression

Return Value

Expression containing the custom name

Example

This example returns the expression value for a custom name.

FarPoint.Win.Spread.Model.ICustomNameSupport cns;
FarPoint.CalcEngine.Expression ex;
cns = (FarPoint.Win.Spread.Model.ICustomNameSupport)fpSpread1.ActiveSheet.Models.Data;
cns.AddCustomName("ALPHA", new FarPoint.CalcEngine.DoubleExpression(20));
fpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA");
ex = cns.GetCustomName("ALPHA");
label1.Text = "The type of the custom name is " + ex.ToString();

Visual Basic

Dim cns As FarPoint.Win.Spread.Model.ICustomNameSupport
Dim ex As FarPoint.CalcEngine.Expression
cns = FpSpread1.ActiveSheet.Models.Data
cns.AddCustomName("ALPHA", New FarPoint.CalcEngine.DoubleExpression(20))
FpSpread1.ActiveSheet.SetFormula(1, 1, "ALPHA")
ex = cns.GetCustomName("ALPHA")
Label1.Text = "The type of the custom name is " & 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

Reference

ICustomNameSupport Interface
ICustomNameSupport Members
Overload List