Spread for ASP.NET 13 Product Documentation
FarPoint.Web.Spread Assembly / FarPoint.Web.Spread.Model Namespace / DefaultSheetDataModel Class / GetCustomName Method / GetCustomName(String,Int32,Int32) Method
Custom name to get
Base row index for computing relative cell references
Base column index for computing relative cell references
Example


In This Topic
    GetCustomName(String,Int32,Int32) Method
    In This Topic
    Gets a named expression from the model with the specified base index for relative cell references.
    Syntax
    '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
    Remarks
    This method gets a custom name from the model with relative cell references.
    Example
    This example returns a custom name from the model.
    FarPoint.Web.Spread.Model.DefaultSheetDataModel 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");
    
    string s;
    s = dataModel.GetCustomName("ALPHA", 1, 1).ToString();
    Response.Write(s);
    
    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")
    
    Dim s As String
    s = dataModel.GetCustomName("ALPHA", 1, 1)
    Response.Write(s)
    See Also