Spread Windows Forms 8.0 Product Documentation
RemoveCustomFunction Method (SheetView)
Example 


Name of custom function to remove
Removes a user-defined custom function (FunctionInfo object) on this sheet from the model.
Syntax
'Declaration
 
Public Sub RemoveCustomFunction( _
   ByVal name As String _
) 
'Usage
 
Dim instance As SheetView
Dim name As String
 
instance.RemoveCustomFunction(name)
public void RemoveCustomFunction( 
   string name
)

Parameters

name
Name of custom function to remove
Remarks
For more information on using formulas, refer to the Formula Reference.
Example
This example removes a user-defined custom function from the sheet.
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;
      }
    }

DialogResult dlg;
fpSpread1.ActiveSheet.AddCustomFunction(new CubeFunctionInfo());
fpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)");
dlg = MessageBox.Show("Do you want to remove the custom function?", "RemoveCustomFunction", MessageBoxButtons.YesNo);
if (dlg == DialogResult.Yes)
{
fpSpread1.ActiveSheet.RemoveCustomFunction("CUBE");
fpSpread1.ActiveSheet.RecalculateAll();
}
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 dlg As DialogResult
FpSpread1.ActiveSheet.AddCustomFunction(New CubeFunctionInfo())
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)")
dlg = MessageBox.Show("Do you want to remove the custom function?", "RemoveCustomFunction", MessageBoxButtons.YesNo)
If dlg = DialogResult.Yes Then
FpSpread1.ActiveSheet.RemoveCustomFunction("CUBE")
FpSpread1.ActiveSheet.RecalculateAll()
End If
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

Reference

SheetView Class
SheetView Members
AddCustomFunction Method

User-Task Documentation

Creating and Using Custom Functions

 

 


Copyright © GrapeCity, inc. All rights reserved.