Spread Windows Forms 9.0 Product Documentation
SetModelScopeCustomNameComment Method (DefaultSheetDataModel)
Example 


The name of the custom name to set
The comment for the custom name
Sets a custom name comment.
Syntax
'Declaration
 
Public Function SetModelScopeCustomNameComment( _
   ByVal name As String, _
   ByVal comment As String _
) As Boolean
'Usage
 
Dim instance As DefaultSheetDataModel
Dim name As String
Dim comment As String
Dim value As Boolean
 
value = instance.SetModelScopeCustomNameComment(name, comment)
public bool SetModelScopeCustomNameComment( 
   string name,
   string comment
)

Parameters

name
The name of the custom name to set
comment
The comment for the custom name

Return Value

true if successful; otherwise, false
Example
This example uses the SetModelScopeCustomNameComment method.
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
//Can use this method to change an existing comment
modelCustomNameSupport.SetModelScopeCustomNameComment("Test_1", "Changed comment");
string comment = modelCustomNameSupport.GetModelScopeCustomNameComment("Test_1");
string comment1 = modelCustomNameSupport.GetCustomNameComment("Test_2");
listBox1.Items.Add(comment);
listBox1.Items.Add(comment1);
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")
'Can use this method to change an existing comment
modelCustomNameSupport.SetModelScopeCustomNameComment("Test_1", "Changed comment")
Dim comment As String = modelCustomNameSupport.GetModelScopeCustomNameComment("Test_1")
Dim comment1 As String = modelCustomNameSupport.GetCustomNameComment("Test_2")
ListBox1.Items.Add(comment)
ListBox1.Items.Add(comment1)
Requirements

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

See Also

Reference

DefaultSheetDataModel Class
DefaultSheetDataModel Members

 

 


Copyright © GrapeCity, inc. All rights reserved.