GetCustomFunction メソッド (SheetView)

このシートのモデルからユーザー定義のカスタム関数（FunctionInfoオブジェクト）を取得します。

構文

Visual Basic
C#

'Declaration
 
Public Function GetCustomFunction( _
   ByVal name As String _
) As FunctionInfo

'使用法
 
Dim instance As SheetView
Dim name As String
Dim value As FunctionInfo
 
value = instance.GetCustomFunction(name)

public FunctionInfo GetCustomFunction( 
   string name
)

パラメータ

name: 取得するカスタム関数の名前

戻り値の型

指定した名前のユーザー定義カスタム関数を含む FunctionInfo オブジェクト。存在しない場合は Null

解説

数式でのカスタム関数の使用の詳細については、「関数リファレンス」を参照してください。

例

次のサンプルコードでは、このメンバを使用して、モデルからユーザー定義のカスタム関数（Functionオブジェクト）を返しています。

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 Basic

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)")

参照

SheetView クラス
 SheetView メンバ
 AddCustomFunction メソッド

開発者ガイド

カスタム関数の作成