GetCustomFunction メソッド (ICustomFunctionSupport)

モデルからユーザー定義関数を取得します。

構文

Visual Basic
C#

'宣言
 
Function GetCustomFunction( _
   ByVal name As String _
) As FunctionInfo

FunctionInfo GetCustomFunction( 
   string name
)

パラメータ

name: 関数の名前

戻り値の型

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

使用例

次のサンプルコードは、カスタム関数の名前を返します。

C#
Visual Basic

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)");
FarPoint.CalcEngine.FunctionInfo fi;
fi = cfs.GetCustomFunction("CUBE");
listBox1.Items.Add("The name of the custom function is " + fi.Name);

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

参照

ICustomFunctionSupport インターフェース
 ICustomFunctionSupport メンバ