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


name
Custom name to get
baseRow
Base row index for computing relative cell references
baseColumn
Base column index for computing relative cell references

Glossary Item Box

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

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 DefaultSheetDataModel
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 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.
C#Copy Code
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 BasicCopy Code
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 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.