Spread ASP.NET 6.0 Product Documentation
GetCustomFunction Method
See Also  Example Send Feedback
FarPoint.Web.Spread Assembly > FarPoint.Web.Spread.Model Namespace > DefaultSheetDataModel Class : GetCustomFunction Method


name
Name of the user-defined custom function to get

Glossary Item Box

Gets a user-defined custom function from the model.

Syntax

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

Parameters

name
Name of the user-defined custom function to get

Return Value

String containing the name of the custom function

Example

This example adds a custom function to the data model.
C#Copy Code
<Serializable()>
	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; 
		} 
	} 
	
private void PageLoad(object sender, System.EventArgs e)
{
	FarPoint.Web.Spread.Model.DefaultSheetDataModel dataModel = new FarPoint.Web.Spread.Model.DefaultSheetDataModel(5, 5); 
	dataModel.AddCustomFunction(new CubeFunctionInfo()); 
	dataModel.SetFormula(1, 1, "CUBE(4)"); 
	FpSpread1.ActiveSheetView.DataModel = dataModel;
	
	FarPoint.CalcEngine.FunctionInfo fi;
	fi = dataModel.GetCustomFunction("CUBE");
	Response.Write(fi.MinArgs.ToString());	
}
Visual BasicCopy Code
<Serializable()> 
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

Private Sub PageLoad(ByVal sender As System.Object, ByVal e As System.EventArgs) Handles MyBase.Load
Dim dataModel As New FarPoint.Web.Spread.Model.DefaultSheetDataModel(5, 5)
dataModel.AddCustomFunction(New CubeFunctionInfo)
dataModel.SetFormula(1, 1, "CUBE(4)")
FpSpread1.ActiveSheetView.DataModel = dataModel

Dim fi As FarPoint.CalcEngine.FunctionInfo
fi = dataModel.GetCustomFunction("CUBE")
Response.Write(fi.MinArgs.ToString())
End Sub

Requirements

Target Platforms: Windows 98, Windows NT 4.0, Windows Millennium Edition, Windows 2000, Windows XP Home Edition, Windows XP Professional, Windows Server 2003 family, Windows Vista, Windows Server 2008 family

See Also

© 2002-2012 GrapeCity, Inc. All Rights Reserved.