Spread Windows Forms 6.0 Product Documentation
GetCustomFunction Method
See Also  Example Support Options
FarPoint.Win.Spread Assembly > FarPoint.Win.Spread.Model Namespace > ICustomFunctionSupport Interface : GetCustomFunction Method


name
Name of function

Glossary Item Box

Gets a user-defined function from the model.

Syntax

Visual Basic (Declaration) 
Function GetCustomFunction( _
   ByVal name As String _
) As FunctionInfo
Visual Basic (Usage)Copy Code
Dim instance As ICustomFunctionSupport
Dim name As String
Dim value As FunctionInfo
 
value = instance.GetCustomFunction(name)
C# 
FunctionInfo GetCustomFunction( 
   string name
)

Parameters

name
Name of function

Return Value

FunctionInfo object containing the specified name of the user-defined custom function, or null if none exists

Example

This example returns the name of a custom function.
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)");
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
Dim fi As FarPoint.CalcEngine.FunctionInfo
cfs = FpSpread1.ActiveSheet.Models.Data
cfs.AddCustomFunction(New CubeFunctionInfo())
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)")
fi = cfs.GetCustomFunction("CUBE")
Label1.Text = "The name of the custom function is " & fi.Name

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.