GetCustomFunction Method

Visual Basic
C#

'Declaration
 
Function GetCustomFunction( _
   ByVal name As String _
) As FunctionInfo

'Usage
 
Dim instance As ICustomFunctionSupport
Dim name As String
Dim value As FunctionInfo
 
value = instance.GetCustomFunction(name)

FunctionInfo GetCustomFunction( 
   string name
)

Parameters

name: Name of function

Return Value

FunctionInfo object containing the specified name of the user-defined custom function, or null if none exists

This example returns the name of a custom function.

C#

public class CubeFunctionInfo : FarPoint.CalcEngine.FunctionInfo
    {
      public override string Name { get { return "CUBE"; } }
      public override int MinArgs { get { return 1; } }
      public override int MaxArgs { get { return 1; } }
      public override object Evaluate (object[] args)
      {
        double num = FarPoint.CalcEngine.CalcConvert.ToDouble(args[0]);
        return num * num * num;
      }
    }

FarPoint.Win.Spread.Model.ICustomFunctionSupport cfs;
cfs = (FarPoint.Win.Spread.Model.ICustomFunctionSupport)fpSpread1.ActiveSheet.Models.Data;
cfs.AddCustomFunction(new CubeFunctionInfo());
fpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)");
FarPoint.CalcEngine.FunctionInfo fi;
fi = cfs.GetCustomFunction("CUBE");
listBox1.Items.Add("The name of the custom function is " + fi.Name);

Visual Basic

Public Class CubeFunctionInfo
   Inherits FarPoint.CalcEngine.FunctionInfo

   Public Overrides ReadOnly Property Name() As String
        Get
             Return "CUBE"
        End Get
   End Property

   Public Overrides ReadOnly Property MinArgs() As Integer
       Get
             Return 1
        End Get
   End Property

   Public Overrides ReadOnly Property MaxArgs() As Integer
        Get
             Return 1
        End Get
   End Property

   Public Overrides Function Evaluate(ByVal args() As Object) As Object
        Dim num As Double = FarPoint.CalcEngine.CalcConvert.ToDouble(args(0))
        Return num * num * num
   End Function
End Class

Dim cfs As FarPoint.Win.Spread.Model.ICustomFunctionSupport
Dim fi As FarPoint.CalcEngine.FunctionInfo
cfs = FpSpread1.ActiveSheet.Models.Data
cfs.AddCustomFunction(New CubeFunctionInfo())
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)")
fi = cfs.GetCustomFunction("CUBE")
Label1.Text = "The name of the custom function is " & fi.Name

Reference

ICustomFunctionSupport Interface
ICustomFunctionSupport Members