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


name
Name of custom function to get

Glossary Item Box

Gets a user-defined custom function (FunctionInfo object) from the model for this sheet.

Syntax

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

Parameters

name
Name of custom function to get

Return Value

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

Remarks

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

Example

This example illustrates the use of this member by returning a user-defined custom function (Function object) from 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;
      }
    }

fpSpread1.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

FpSpread1.ActiveSheet.AddCustomFunction(New CubeFunctionInfo)
FpSpread1.ActiveSheet.SetFormula(1, 1, "CUBE(4)")

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.