Spread Windows Forms 8.0 Product Documentation
GetCustomName(String) Method
Example 


Custom name to get
Gets the expression value for a custom name on this sheet from the model.
Syntax
'Declaration
 
Public Overloads Function GetCustomName( _
   ByVal name As String _
) As Expression
'Usage
 
Dim instance As SheetView
Dim name As String
Dim value As Expression
 
value = instance.GetCustomName(name)
public Expression GetCustomName( 
   string name
)

Parameters

name
Custom name to get

Return Value

Expression containing the custom name
Remarks

Custom names are identifiers to represent information in the spreadsheet. A custom name can refer to a cell, a range of cells, a computed value, or a formula. Methods that deal with custom names provide the same functionality as the Name in Microsoft Excel.

The name can contain up to 255 characters and can include letters, numbers, or underscores. The first character must be a letter or an underscore.

For more information on on using custom names in formulas, refer to the Formula Reference.

Example
This example illustrates the use of this member by returning the expression value for a custom name from the sheet.
FarPoint.CalcEngine.Expression ex; 
fpSpread1.ActiveSheet.AddCustomName("Alpha", "Sum(A1,A2)", 1, 1);
fpSpread1.ActiveSheet.SetFormula(1, 1, "Alpha");
fpSpread1.ActiveSheet.SetValue(0, 0, 10);
fpSpread1.ActiveSheet.SetValue(1, 0, 10);
ex = fpSpread1.ActiveSheet.GetCustomName("Alpha");
label1.Text = ex.ToString();
Dim ex As FarPoint.CalcEngine.Expression
FpSpread1.ActiveSheet.AddCustomName("Alpha", "Sum(A1,A2)", 1, 1)
FpSpread1.ActiveSheet.SetFormula(1, 1, "Alpha")
FpSpread1.ActiveSheet.SetValue(0, 0, 10)
FpSpread1.ActiveSheet.SetValue(1, 0, 10)
ex = FpSpread1.ActiveSheet.GetCustomName("Alpha")
Label1.Text = ex.ToString()
Requirements

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

See Also

Reference

SheetView Class
SheetView Members
Overload List

 

 


Copyright © GrapeCity, inc. All rights reserved.