Syntax
| Visual Basic (Declaration) | |
|---|---|
Public Sub AddCustomFunction( _ ByVal functionInfo As FunctionInfo _ ) | |
| Visual Basic (Usage) |  Copy Code |
|---|---|
Dim instance As DefaultSheetDataModel Dim functionInfo As FunctionInfo instance.AddCustomFunction(functionInfo) | |
| C# | |
|---|---|
public void AddCustomFunction( FunctionInfo functionInfo ) | |
Parameters
- functionInfo
- FunctionInfo object containing the user-defined function to add
Exceptions
| Exception | Description |
|---|---|
| System.ArgumentNullException | No function specified; function is a null reference (Nothing in Visual Basic) |
Remarks
For more information on using custom functions in formulas, refer to the Formula Reference.
Example
This example adds a new user-defined custom function to the model for use in formulas.
| C# | Copy Code |
|---|---|
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.DefaultSheetDataModel dataModel = new FarPoint.Win.Spread.Model.DefaultSheetDataModel(3, 3); dataModel.AddCustomFunction(new CubeFunctionInfo()); dataModel.SetFormula(1, 1, "CUBE(4)"); fpSpread1.ActiveSheet.Models.Data = dataModel; | |
| Visual Basic | Copy Code |
|---|---|
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 dataModel As New FarPoint.Win.Spread.Model.DefaultSheetDataModel(5, 5) dataModel.AddCustomFunction(New CubeFunctionInfo()) dataModel.SetFormula(1, 1, "CUBE(4)") FpSpread1.ActiveSheet.Models.Data = dataModel | |
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