Aspose::Cells::ExternalConnections::ConnectionParameter class
Contents
[
Hide
]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 |
|---|---|
| ConnectionParameter(ConnectionParameter_Impl* impl) | Constructs from an implementation object. |
| ConnectionParameter(const ConnectionParameter& src) | Copy constructor. |
| 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. |
| 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. |
| IsNull() const | Checks whether the implementation object is nullptr. |
| explicit operator bool() const | operator bool() |
| operator=(const ConnectionParameter& src) | operator= |
| SetCellReference(const U16String& value) | Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell. |
| SetCellReference(const char16_t* value) | Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell. |
| SetName(const U16String& value) | The name of the parameter. |
| SetName(const char16_t* value) | The name of the parameter. |
| SetPrompt(const U16String& 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. |
| SetPrompt(const char16_t* 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. |
| SetRefreshOnChange(bool 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). |
| SetSqlType(SqlDataType value) | SQL data type of the parameter. Only valid for ODBC sources. |
| SetType(ConnectionParameterType value) | 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. |
| SetValue(const Aspose::Cells::Object& value) | Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value. |
| ~ConnectionParameter() | Destructor. |
Fields
| Field | Description |
|---|---|
| _impl | The implementation object. |
See Also
- Namespace Aspose::Cells::ExternalConnections
- Library Aspose.Cells for C++