ConnectionParameter

ConnectionParameter class

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

class ConnectionParameter;

Methods

Method	Description
getSqlType()	SQL data type of the parameter. Only valid for ODBC sources.
setSqlType(SqlDataType)	SQL data type of the parameter. Only valid for ODBC sources.
getRefreshOnChange()	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).
setRefreshOnChange(boolean)	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).
getPrompt()	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.
setPrompt(string)	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.
getType()	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.
setType(ConnectionParameterType)	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.
getName()	The name of the parameter.
setName(string)	The name of the parameter.
getCellReference()	Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.
setCellReference(string)	Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.
getValue()	Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.
setValue(object)	Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.
isNull()	Checks whether the implementation object is null.

getSqlType()

SQL data type of the parameter. Only valid for ODBC sources.

getSqlType() : SqlDataType;

Returns

SqlDataType

setSqlType(SqlDataType)

SQL data type of the parameter. Only valid for ODBC sources.

setSqlType(value: SqlDataType) : void;

Parameters:

Parameter	Type	Description
value	SqlDataType	The value to set.

getRefreshOnChange()

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).

getRefreshOnChange() : boolean;

setRefreshOnChange(boolean)

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).

setRefreshOnChange(value: boolean) : void;

Parameters:

Parameter	Type	Description
value	boolean	The value to set.

getPrompt()

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.

getPrompt() : string;

setPrompt(string)

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.

setPrompt(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getType()

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.

getType() : ConnectionParameterType;

Returns

ConnectionParameterType

setType(ConnectionParameterType)

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.

setType(value: ConnectionParameterType) : void;

Parameters:

Parameter	Type	Description
value	ConnectionParameterType	The value to set.

getName()

The name of the parameter.

getName() : string;

setName(string)

The name of the parameter.

setName(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getCellReference()

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

getCellReference() : string;

setCellReference(string)

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

setCellReference(value: string) : void;

Parameters:

Parameter	Type	Description
value	string	The value to set.

getValue()

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

getValue() : object;

setValue(object)

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

setValue(value: object) : void;

Parameters:

Parameter	Type	Description
value	object	The value to set.

isNull()

Checks whether the implementation object is null.

isNull() : boolean;