| Property Getters/Setters Summary | ||
|---|---|---|
method | getCellReference() | |
method | setCellReference(value) | |
| Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell. | ||
method | getName() | |
method | setName(value) | |
| The name of the parameter. | ||
method | getPrompt() | |
method | setPrompt(value) | |
| 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. | ||
method | getRefreshOnChange() | |
method | setRefreshOnChange(value) | |
| 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). | ||
method | getSqlType() | |
method | setSqlType(value) | |
| SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant. | ||
method | 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.
|
||
method | getValue() | |
method | setValue(value) | |
| Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value. | ||
int getSqlType() / setSqlType(value)
boolean getRefreshOnChange() / setRefreshOnChange(value)
String getPrompt() / setPrompt(value)
ConnectionParameterType getType()
String getName() / setName(value)
String getCellReference() / setCellReference(value)
Object getValue() / setValue(value)