SetCustomNameComment Method (SheetView)

Visual Basic
C#

'Declaration
 
Public Function SetCustomNameComment( _
   ByVal name As String, _
   ByVal comment As String, _
   ByVal sheetViewScope As Boolean _
) As Boolean

'Usage
 
Dim instance As SheetView
Dim name As String
Dim comment As String
Dim sheetViewScope As Boolean
Dim value As Boolean
 
value = instance.SetCustomNameComment(name, comment, sheetViewScope)

public bool SetCustomNameComment( 
   string name,
   string comment,
   bool sheetViewScope
)

Parameters

name: Name of custom name to which to add a comment
comment: Comment to add
sheetViewScope: If true, add to model scope; if false, add to custom name to share

Return Value

If true, comment is set; otherwise, false.

This example uses the SetCustomNameComment method.

C#

fpSpread1.ActiveSheet.AddCustomName("Alpha", new FarPoint.CalcEngine.DoubleExpression(20), false, "Extra information");
fpSpread1.ActiveSheet.SetFormula(1, 1, "Alpha");
fpSpread1.ActiveSheet.SetCustomNameComment("Alpha", "New information", false);
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"
FpSpread1.ActiveSheet.SetCustomNameComment("Alpha", "New information", False)
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