GetCustomName(String,Int32,Int32) Method

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

Syntax

Visual Basic
C#

'Declaration
 
Public Overloads Function GetCustomName( _
   ByVal name As String, _
   ByVal baseRow As Integer, _
   ByVal baseColumn As Integer _
) As String

'Usage
 
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)

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

Example

This example uses the GetCustomName method.

FarPoint.Web.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Web.Spread.Model.DefaultSheetDataModel();
dataModel = (FarPoint.Web.Spread.Model.DefaultSheetDataModel)FpSpread1.ActiveSheetView.DataModel;
dataModel.AddCustomName("ALPHA", "SUM(A1, A2)", 1, 1);
FpSpread1.ActiveSheetView.SetValue(0, 0, 10);
FpSpread1.ActiveSheetView.SetValue(1, 0, 100);
FpSpread1.ActiveSheetView.SetFormula(1, 1, "ALPHA");
TextBox1.Text = FpSpread1.ActiveSheetView.GetCustomName("ALPHA", 0, 0).ToString();

Visual Basic

Dim dataModel As New FarPoint.Web.Spread.Model.DefaultSheetDataModel()
dataModel = FpSpread1.ActiveSheetView.DataModel
dataModel.AddCustomName("ALPHA", "SUM(A1, A2)", 1, 1)
FpSpread1.ActiveSheetView.SetValue(0, 0, 10)
FpSpread1.ActiveSheetView.SetValue(1, 0, 100)
FpSpread1.ActiveSheetView.SetFormula(1, 1, "ALPHA")
TextBox1.Text = FpSpread1.ActiveSheetView.GetCustomName("ALPHA", 0, 0).ToString()

Requirements

Target Platforms: Windows 7, Windows 8, Windows 10, Windows Vista, Windows Server 2003, Windows Server 2008, Windows Server 2012, Windows XP Professional

Reference

SheetView Class
SheetView Members
Overload List