Spread Windows Forms 7.0 Product Documentation
ClearCustomFunctions Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.Model Namespace > ICustomFunctionSupport2 Interface : ClearCustomFunctions Method


Glossary Item Box

Removes all user-defined functions from the model.

Syntax

Visual Basic (Declaration) 
Sub ClearCustomFunctions() 
Visual Basic (Usage)Copy Code
Dim instance As ICustomFunctionSupport2
 
instance.ClearCustomFunctions()
C# 
void ClearCustomFunctions()

Example

This examples clears the custom functions in 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; 
} 
} 

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.Win.Spread.Model.ICustomFunctionSupport2 icf2;
icf2 = (FarPoint.Win.Spread.Model.ICustomFunctionSupport2)fpSpread1.ActiveSheet.Models.Data;
icf2.ClearCustomFunctions();
fpSpread1.ActiveSheet.RecalculateAll();
Visual BasicCopy 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 cfs As FarPoint.Win.Spread.Model.ICustomFunctionSupport
cfs = FpSpread1.ActiveSheet.Models.Data
cfs.AddCustomFunction(New CubeFunctionInfo)
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)")

Dim icf2 As FarPoint.Win.Spread.Model.ICustomFunctionSupport2
icf2 = FpSpread1.ActiveSheet.Models.Data
icf2.ClearCustomFunctions()
FpSpread1.ActiveSheet.RecalculateAll()

Requirements

Target Platforms: Windows 2000 Professional (SP4), Windows 2000 Server, Windows 2003 Server (SP1), Windows 2008, Windows XP (SP2), Windows Vista, Windows 7, Windows 8

See Also

© 2002-2014 ComponentOne, a division of GrapeCity. All Rights Reserved.