ConnectionParameter
Source: aspose.
Specifies properties about any parameters used with external data connections Parameters are valid for ODBC and web queries.
Methods
getCellReference()
Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
getName()
The name of the parameter.
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.
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).
getSqlType()
SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
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.
getValue()
Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.
setCellReference()
Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
setName()
The name of the parameter.
setPrompt()
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.
setRefreshOnChange()
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).
setSqlType()
SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
setValue()
Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.