Gets a user-defined custom function (FunctionInfo object) from the model for this sheet.
Syntax
| Visual Basic (Usage) |  Copy Code |
|---|
Dim instance As SheetView
Dim name As String
Dim value As FunctionInfo
value = instance.GetCustomFunction(name) |
Parameters
- name
- Name of custom function to get
Return Value
FunctionInfo object containing the specified name of the user-defined custom function, or null if none exists
Remarks
Example
This example illustrates the use of this member by returning a user-defined custom function (Function object) from the model.
| 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;
}
}
fpSpread1.AddCustomFunction(new CubeFunctionInfo());
fpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)");
|
| 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
FpSpread1.ActiveSheet.AddCustomFunction(New CubeFunctionInfo)
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)") |
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
