AddCustomFunction Method (SheetView)

Adds a user-defined custom function (FunctionInfo object) to the model for use in formulas.

Syntax

Visual Basic
C#

'Declaration
 
Public Sub AddCustomFunction( _
   ByVal functionInfo As FunctionInfo _
)

'Usage
 
Dim instance As SheetView
Dim functionInfo As FunctionInfo
 
instance.AddCustomFunction(functionInfo)

public void AddCustomFunction( 
   FunctionInfo functionInfo
)

Parameters

functionInfo: FunctionInfo object of the custom function to add

Remarks

For more information on using custom functions, refer to the Formula Reference.

Example

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.SheetView sv;
sv = fpSpread1.ActiveSheet;
sv.AddCustomFunction((new CubeFunctionInfo));
sv.SetFormula(1, 1, "CUBE(4)");

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 sv As FarPoint.Win.Spread.SheetView
sv = FpSpread1.ActiveSheet
sv.AddCustomFunction((New CubeFunctionInfo))
sv.SetFormula(1, 1, "CUBE(4)")

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

SheetView Class
SheetView Members
GetCustomFunction Method
RemoveCustomFunction Method
Custom Functions in Formulas

User-Task Documentation

Creating and Using Custom Functions