Share via


extensionFunctionParameter object

Array that defines the input parameters for the function.

Properties that reference this object type:

Syntax

{
  "name": "{string}",
  "description": "{string}",
  "type": "{string}",
  "cellValueType": "cellvalue | booleancellvalue | doublecellvalue | entitycellvalue | errorcellvalue | formattednumbercellvalue | linkedentitycellvalue | localimagecellvalue | stringcellvalue | webimagecellvalue | ",
  "dimensionality": "scalar | matrix",
  "optional": {boolean},
  "repeating": {boolean}
}

Properties

name

The name of the parameter. This name is displayed in Excel's IntelliSense.

This property is localizable. For more information, see the localization schema.

Type
string

Required

Constraints
Minimum string length: 1. Maximum string length: 64.

Supported values

description

A description of the parameter. This is displayed in Excel's IntelliSense.

This property is localizable. For more information, see the localization schema.

Type
string

Required

Constraints
Minimum string length: 1. Maximum string length: 128.

Supported values

type

The data type of the parameter. It can only be boolean, number, string, any, CustomFunctions.Invocation, CustomFunctions.StreamingInvocation or CustomFunctions.CancelableInvocation, any allows you to use any of other types.

Type
string

Required

Constraints
Minimum string length: 1. Maximum string length: 128.

Supported values

cellValueType

A subfield of the type property. Specifies the Excel data types accepted by the custom function. Accepts the values cellvalue, booleancellvalue, doublecellvalue, entitycellvalue, errorcellvalue, formattednumbercellvalue, linkedentitycellvalue, localimagecellvalue, stringcellvalue, webimagecellvalue

Type
string

Required

Constraints

Supported values
Allowed values: cellvalue, booleancellvalue, doublecellvalue, entitycellvalue, errorcellvalue, formattednumbercellvalue, linkedentitycellvalue, localimagecellvalue, stringcellvalue, webimagecellvalue, ``.

dimensionality

Must be either scalar (a non-array value) or matrix (a 2-dimensional array).

Type
string

Required

Constraints

Supported values
Allowed values: scalar, matrix.

optional

If true, the parameter is optional.

Type
boolean

Required

Constraints

Supported values
Default value: False.

repeating

If true, parameters populate from a specified array. Note that functions all repeating parameters are considered optional parameters by definition.

Type
boolean

Required

Constraints

Supported values
Default value: False.