ConnectionParameter

ConnectionParameter class

Specifies properties about any parameters used with external data connections Parameters are valid for ODBC and web queries.

Properties

Name	Type	Description
SqlType	int	SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
RefreshOnChange	boolean	Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter v
Prompt	String	Prompt string for the parameter. Presented to the spreadsheet user along with input UI to collect the parameter value be
Type	ConnectionParameterType	Type of parameter used. If the parameterType=value, then the value from boolean, double, integer, or string will be used
Name	String	The name of the parameter.
CellReference	String	Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.
Value	Object	Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when para

ConnectionParameter.SqlType property

SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.

Type: int

ConnectionParameter.RefreshOnChange property

Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes. If true, then external data is refreshed using the new parameter value every time there’s a change. If false, then external data is only refreshed when requested by the user, or some other event triggers refresh (e.g., workbook opened).

Type: boolean

ConnectionParameter.Prompt property

Prompt string for the parameter. Presented to the spreadsheet user along with input UI to collect the parameter value before refreshing the external data. Used only when parameterType = prompt.

Type: String

ConnectionParameter.Type property

Type of parameter used. If the parameterType=value, then the value from boolean, double, integer, or string will be used. In this case, it is expected that only one of {boolean, double, integer, or string} will be specified.

Type: ConnectionParameterType

ConnectionParameter.Name property

The name of the parameter.

Type: String

ConnectionParameter.CellReference property

Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.

Type: String

ConnectionParameter.Value property

Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.

Type: Object