RemoveCustomFunction Method (ICustomFunctionSupport)

Removes a user-defined function from the model.

Syntax

Visual Basic
C#

'Declaration
 
Sub RemoveCustomFunction( _
   ByVal name As String _
)

'Usage
 
Dim instance As ICustomFunctionSupport
Dim name As String
 
instance.RemoveCustomFunction(name)

void RemoveCustomFunction( 
   string name
)

Parameters

name: Name of function to remove

Example

<Serializable()>
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.Web.Spread.Model.ICustomFunctionSupport cfs; 
cfs = (FarPoint.Web.Spread.Model.ICustomFunctionSupport)FpSpread1.ActiveSheetView.DataModel; 
cfs.AddCustomFunction(new CubeFunctionInfo()); 
FpSpread1.ActiveSheetView.SetFormula(1, 1, "CUBE(4)");

private void Button1Click(object sender, System.EventArgs e)
{
FarPoint.Web.Spread.Model.ICustomFunctionSupport cfs; 
cfs = (FarPoint.Web.Spread.Model.ICustomFunctionSupport)FpSpread1.ActiveSheetView.DataModel; 
cfs.RemoveCustomFunction("Cube");
FpSpread1.ActiveSheetView.Recalculate();
}

Visual Basic

<Serializable()> 
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.Web.Spread.Model.ICustomFunctionSupport
cfs = FpSpread1.ActiveSheetView.DataModel
cfs.AddCustomFunction(New CubeFunctionInfo)
FpSpread1.ActiveSheetView.SetFormula(1, 1, "CUBE(4)")

Private Sub Button1Click(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles Button1.Click
Dim cfs As FarPoint.Web.Spread.Model.ICustomFunctionSupport
cfs = FpSpread1.ActiveSheetView.DataModel
cfs.RemoveCustomFunction("Cube")
FpSpread1.ActiveSheetView.Recalculate()
End Sub

Requirements

Target Platforms: Windows 7, Windows 8, Windows Vista, Windows Server 2000, Windows 2000 Professional, Windows XP Professional, Windows NT 4.0 Workstation, SP6, Windows NT 4.0 Server, SP6

Reference

ICustomFunctionSupport Interface
ICustomFunctionSupport Members