GetCustomNameComment Method (SheetView)

Visual Basic
C#

'Declaration
 
Public Function GetCustomNameComment( _
   ByVal name As String, _
   ByVal SheetviewSCope As Boolean _
) As String

'Usage
 
Dim instance As SheetView
Dim name As String
Dim SheetviewSCope As Boolean
Dim value As String
 
value = instance.GetCustomNameComment(name, SheetviewSCope)

public string GetCustomNameComment( 
   string name,
   bool SheetviewSCope
)

Parameters

name
SheetviewSCope: If [true] get from sheet scope, otherwise [false] get from spread scope

Return Value

The comment of the custom name

This example uses the GetCustomNameComment method.

C#

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.NET

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))

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows Server 2012 R2, Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8, Windows 8.1, Windows 10

Reference

SheetView Class
SheetView Members