ParameterType Enum

Lists parameter types.

Namespace: DevExpress.Spreadsheet.Functions

Assembly: DevExpress.Spreadsheet.v21.2.Core.dll

Declaration

C#

[Flags]
public enum ParameterType

VB.NET

<Flags>
Public Enum ParameterType

Members

Name	Description
Reference	The parameter is a reference to a cell, range or defined name.
Value	The parameter is a single value of any type.
Array	Parameter is an array (the function is used in array formula).
Any	Any kind of parameter is allowed.

Related API Members

The following properties accept/return ParameterType values:

• FunctionWrapper.ReturnType
• IFunction.ReturnType
• ParameterInfo.Type

Remarks

Specify the parameter type for the ParameterInfo objects in the IFunction.Parameters array to create a function signature. A function signature provides parameter validation when a function is evaluated.

Related GitHub Examples

The following code snippets (auto-collected from DevExpress Examples) contain references to the ParameterType enum.

Note

The algorithm used to collect these code examples remains a work in progress. Accordingly, the links and snippets below may produce inaccurate results. If you encounter an issue with code examples below, please use the feedback form on this page to report the issue.

C#

udf-custom-function-how-to-replace-excel-xll-add-in-udf-with-a-custom-function-e5178/CS/UDF_Discount/DiscountFunction.cs#L19

{
    this.functionParameters = new ParameterInfo[] { new ParameterInfo(ParameterType.Value, ParameterAttributes.Required),
    new ParameterInfo(ParameterType.Value, ParameterAttributes.Required)};

wpf-spreadsheetcontrol-api-part-2-e4944/CS/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/CustomFunctionActions.cs#L78

// Missing optional parameters do not result in error message.
this.functionParameters = new ParameterInfo[] { new ParameterInfo(ParameterType.Value, ParameterAttributes.Required),
    new ParameterInfo(ParameterType.Value, ParameterAttributes.Optional)};

winforms-spreadsheetcontrol-api-part-2-e4832/CS/SpreadsheetControl_API_Part02/SpreadsheetActions/CustomFunctionActions.cs#L81

// Missing optional parameters do not result in an error message.
this.functionParameters = new ParameterInfo[] { new ParameterInfo(ParameterType.Value, ParameterAttributes.Required),
    new ParameterInfo(ParameterType.Value, ParameterAttributes.Optional)};

udf-custom-function-a-sample-custom-function-that-returns-an-array-t538369/CS/CustomFunctionReturningArrayExample/TestArrayCustomFunction.cs#L14

private string name = "TESTARRAY";
private ParameterInfo[] parameters = new ParameterInfo[] { new ParameterInfo(ParameterType.Array, ParameterAttributes.Required) };
private ParameterType return_type = ParameterType.Array;

udf-custom-function-a-sample-custom-function-that-returns-an-array-t538770/CS/CustomFunctionReturningArrayExample/TestArrayCustomFunction.cs#L10

private string name = "TESTARRAY";
private ParameterInfo[] parameters = new ParameterInfo[] { new ParameterInfo(ParameterType.Array, ParameterAttributes.Required) };
private ParameterType return_type = ParameterType.Array;

VB.NET

how-to-use-excel-add-ins-in-the-spreadsheet-control-e5012/VB/SpreadsheetAddIn/Form1.vb#L95

Return New ParameterInfo() { _
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Required), _
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Optional) _

wpf-spreadsheetcontrol-api-part-2-e4944/VB/SpreadsheetControl_WPF_API_Part02/SpreadsheetActions/CustomFunctionActions.vb#L79

Me.functionParameters = New ParameterInfo() {
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Required),
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Optional)

winforms-spreadsheetcontrol-api-part-2-e4832/VB/SpreadsheetControl_API_Part02/SpreadsheetActions/CustomFunctionActions.vb#L82

Me.functionParameters = New ParameterInfo() {
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Required),
    New ParameterInfo(ParameterType.Value, ParameterAttributes.Optional)

udf-custom-function-how-to-replace-excel-xll-add-in-udf-with-a-custom-function-e5178/VB/UDF_Discount/DiscountFunction.vb#L19

Public Sub New()
    Me.functionParameters = New ParameterInfo() { New ParameterInfo(ParameterType.Value, ParameterAttributes.Required), New ParameterInfo(ParameterType.Value, ParameterAttributes.Required)}
End Sub

udf-custom-function-a-sample-custom-function-that-returns-an-array-t538369/VB/CustomFunctionReturningArrayExample/TestArrayCustomFunction.vb#L18

Private parameters_Renamed() As ParameterInfo = { New ParameterInfo(ParameterType.Array, ParameterAttributes.Required) }
Private return_type As ParameterType = ParameterType.Array