GetCustomName(String,Int32,Int32) Method

Gets a named expression from the model with the specified base index for relative cell references.

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 DefaultSheetDataModel
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 computing relative cell references
baseColumn: Base column index for computing relative cell references

Return Value

String containing the custom name

Example

This example illustrates the use of this member by returning a custom name with relative cell references from 1,1 from the model.

FarPoint.Win.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(5, 5);
dataModel.AddCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1);
dataModel.SetFormula(1, 1, "TWICESUM");
dataModel.SetValue(0, 0, 10);
dataModel.SetValue(1, 0, 10);
fpSpread1.ActiveSheet.Models.Data = dataModel;
listBox1.Items.Add(dataModel.GetCustomName("TWICESUM", 1, 1).ToString());

Visual Basic

Dim dataModel As New FarPoint.Win.Spread.Model.DefaultSheetDataModel(10, 10)
dataModel.AddCustomName("TWICESUM", "2*SUM(A1,A2)", 1, 1)
dataModel.SetFormula(1, 1, "TWICESUM")
dataModel.SetValue(0, 0, 10)
dataModel.SetValue(1, 0, 10)
FpSpread1.ActiveSheet.Models.Data = dataModel
ListBox1.Items.Add(dataModel.GetCustomName("TWICESUM", 1, 1).ToString())

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

Reference

DefaultSheetDataModel Class
DefaultSheetDataModel Members
Overload List