Spread Windows Forms 6.0 Product Documentation
AddCustomFunction Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread Namespace > SheetView Class : AddCustomFunction Method


functionInfo
FunctionInfo object of the custom function to add

Glossary Item Box

Adds a user-defined custom function (FunctionInfo object) to the model for use in formulas.

Syntax

Visual Basic (Declaration) 
Public Sub AddCustomFunction( _
   ByVal functionInfo As FunctionInfo _
) 
Visual Basic (Usage)Copy Code
Dim instance As SheetView
Dim functionInfo As FunctionInfo
 
instance.AddCustomFunction(functionInfo)
C# 
public void AddCustomFunction( 
   FunctionInfo functionInfo
)

Parameters

functionInfo
FunctionInfo object of the custom function to add

Remarks

For more information on on using custom functions, refer to the Formula Reference.

Example

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.SheetView sv;
sv = fpSpread1.ActiveSheet;
sv.AddCustomFunction((new CubeFunctionInfo));
sv.SetFormula(1, 1, "CUBE(4)");
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 sv As FarPoint.Win.Spread.SheetView
sv = FpSpread1.ActiveSheet
sv.AddCustomFunction((New CubeFunctionInfo))
sv.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

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