Spread Windows Forms 6.0 Product Documentation
GetCustomName(String,Int32,Int32) Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SheetView Class > GetCustomName Method : GetCustomName(String,Int32,Int32) Method


name
Custom name to get
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value

Glossary Item Box

Gets the string value for a custom name on this sheet from the model.

Syntax

Visual Basic (Declaration) 
Public Overloads Function GetCustomName( _
   ByVal name As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer _
) As String
Visual Basic (Usage)Copy Code
Dim instance As SheetView
Dim name As String
Dim baseRow As Integer
Dim baseColumn As Integer
Dim value As String
 
value = instance.GetCustomName(name, baseRow, baseColumn)
C# 
public string GetCustomName( 
   string name,
   int baseRow,
   int baseColumn
)

Parameters

name
Custom name to get
baseRow
Base row index for calculating relative row references in the value
baseColumn
Base column index for calculating relative column references in the value

Return Value

String 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 string value for a custom name from the sheet.
C#Copy Code
 
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);
label1.Text = fpSpread1.ActiveSheet.GetCustomName("Alpha", 1, 1).ToString();
Visual BasicCopy Code
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)
Label1.Text = FpSpread1.ActiveSheet.GetCustomName("Alpha", 1, 1).ToString()

Requirements

Target Platforms: Windows 7, Windows Vista SP1 or later, Windows XP SP3, Windows Server 2008 (Server Core not supported), Windows Server 2008 R2 (Server Core supported with SP1 or later), Windows Server 2003 SP2

See Also

© 2002-2012 ComponentOne, a division of GrapeCity. All Rights Reserved.