GetModelScopeCustomNameComment Method (DefaultSheetDataModel)

Visual Basic
C#

'Declaration
 
Public Function GetModelScopeCustomNameComment( _
   ByVal name As String _
) As String

'Usage
 
Dim instance As DefaultSheetDataModel
Dim name As String
Dim value As String
 
value = instance.GetModelScopeCustomNameComment(name)

public string GetModelScopeCustomNameComment( 
   string name
)

Parameters

name

Return Value

Returns the comment of the custom name

This example uses the GetModelScopeCustomNameComment method.

C#

FarPoint.Win.Spread.Model.ISheetDataModel model1 = fpSpread1.Sheets[0].Models.Data;
FarPoint.Win.Spread.Model.DefaultSheetDataModel modelCustomNameSupport = model1 as FarPoint.Win.Spread.Model.DefaultSheetDataModel;
FarPoint.CalcEngine.Expression exp1 = new FarPoint.CalcEngine.CellExpression(0, 0);
modelCustomNameSupport.AddModelScopeCustomName("Test_1", exp1, "comment of sheet scope custom name"); //Custom name for sheetview
modelCustomNameSupport.AddCustomName("Test_2", exp1, "comment of workbook scope custom name");//Custom name for workbook
string comment = modelCustomNameSupport.GetModelScopeCustomNameComment("Test_1");
string comment1 = modelCustomNameSupport.GetCustomNameComment("Test_2");
listBox1.Items.Add(comment);
listBox1.Items.Add(comment1);

VB.NET

Dim model1 As FarPoint.Win.Spread.Model.ISheetDataModel = FpSpread1.Sheets(0).Models.Data
Dim modelCustomNameSupport As FarPoint.Win.Spread.Model.DefaultSheetDataModel = TryCast(model1, FarPoint.Win.Spread.Model.DefaultSheetDataModel)
Dim exp1 As FarPoint.CalcEngine.Expression = New FarPoint.CalcEngine.CellExpression(0, 0)
'Custom name for sheetview
modelCustomNameSupport.AddModelScopeCustomName("Test_1", exp1, "comment of sheet scope custom name")
'Custom name for workbook
modelCustomNameSupport.AddCustomName("Test_2", exp1, "comment of workbook scope custom name")
Dim comment As String = modelCustomNameSupport.GetModelScopeCustomNameComment("Test_1")
Dim comment1 As String = modelCustomNameSupport.GetCustomNameComment("Test_2")
ListBox1.Items.Add(comment)
ListBox1.Items.Add(comment1)

Reference

DefaultSheetDataModel Class
DefaultSheetDataModel Members