Custom, user-defined names are identifiers to represent information in the spreadsheet, used mostly in formulas. A custom name can refer to a cell, a range of cells, a computed value, or a formula. You can define a custom name and then use the name in formulas. When the formula is evaluated, the custom name's value is referenced and evaluated.
You can create sheet level or workbook level custom names. The scope of the sheet level custom name is limited to the sheet it was created for. This allows you to use the same name on several sheets. Formulas in a sheet will ignore sheet level custom names on other sheets.
Use the AddCustomName method in the SheetView class to add workbook or sheet level custom names. The sheetViewScope parameter in the AddCustomName method can be set to true for a sheet level custom name and false for a workbook level custom name. Use the AddModelScopeCustomName method to add sheet level custom names.
Avoid using custom names that start with C# or R# patterns (# stands for any number).
Using Code
Define the custom name using the AddCustomName method. The following examples create workbook level custom names.
Examples
To add a custom name for a cell specified with A1 notation, use the AddCustomName method as shown in this code:
| C# |  Copy Code |
|---|---|
FarPoint.Win.Spread.Model.DefaultSheetDataModel d = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(); d.AddCustomName("test", "$B$1", 0, 0); |
|
| VB | Copy Code |
|---|---|
Dim d FarPoint.Win.Spread.Model.DefaultSheetDataModel = New FarPoint.Win.Spread.Model.DefaultSheetDataModel() d.AddCustomName("test", "$B$1", 0, 0) |
|
To add a custom name for a computed value, use the AddCustomName method as shown in this code:
| C# | Copy Code |
|---|---|
FarPoint.Win.Spread.Model.DefaultSheetDataModel d; d = (FarPoint.Win.Spread.Model.DefaultSheetDataModel)FpSpread1.Sheets[0].Models.Data; d.AddCustomName("alpha", "101", 0, 0); |
|
| VB | Copy Code |
|---|---|
Dim d As New FarPoint.Win.Spread.Model.DefaultSheetDataModel d = (FarPoint.Win.Spread.Model.DefaultSheetDataModel)FpSpread1.Sheets(0).Models.Data d.AddCustomName("alpha", "101", 0, 0) |
|
The following example adds two names where one is a range reference and the other is a formula that references it.
| C# | Copy Code |
|---|---|
| FarPoint.Win.Spread.Model.DefaultSheetDataModel d; d = (FarPoint.Win.Spread.Model.DefaultSheetDataModel)FpSpread1.Sheets[0].DataModel; d.AddCustomName("Sales", "Sheet2!$F$20:$F$50", 0, 0); d.AddCustomName("NetSales", "Sales-SUM(Sheet1!$H$30, Sheet1!$H$40:$H$50)"); |
|
| VB | Copy Code |
|---|---|
| Dim d As New FarPoint.Win.Spread.Model.DefaultSheetDataModel d = (FarPoint.Win.Spread.Model.DefaultSheetDataModel)FpSpread1.Sheets(0).DataModel d.AddCustomName("Sales", "Sheet2!$F$20:$F$50", 0, 0) |
|
Using the Spread Designer
- Select the Data menu in the Spread Designer.
- Select the Name Manager icon.
- Use the New button to add custom names and click the Close button when finished.
- From the File menu choose Apply and Exit to apply your changes to the component and exit Spread Designer.