ParameterAttributes Enum

Lists parameter attributes.

Namespace: DevExpress.Spreadsheet.Functions

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

Declaration

C#

public enum ParameterAttributes

VB.NET

Public Enum ParameterAttributes

Members

Name	Description
Required	The parameter is mandatory. A missing parameter results in a user warning dialog.
Optional	The parameter is not required. If it is missing, the function still compiles and evaluates. Note that optional parameters should come after all required parameters.
OptionalUnlimited	Any number of parameters which are not required. Note that the total number of parameters should not exceed 255 and the optional unlimited parameter should be the final parameter.

Related API Members

The following properties accept/return ParameterAttributes values:

• ParameterInfo.Attributes

Remarks

Specify the parameter attribute 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 ParameterAttributes 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)};

how-to-use-excel-add-ins-in-the-spreadsheet-control-e5012/CS/SpreadsheetAddIn/Form1.cs#L98

    // Missing optional parameters do not result in error message.
    return 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;

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