TDataConnectionParameter Class

This element stores properties about any parameters used with external data connections. Parameters are used to change the query executed externally and cause different data to be retrieved into the workbook.The type of parameter used determines whether the user is prompted for a value before data is refreshed, or the value is pulled from a cell in the workbook, or whether the same value should be used until explicitly changed in the data connection. Parameters are permitted for ODBC and web queries.

Syntax

Namespace: FlexCel.Core

public class TDataConnectionParameter

Methods

Name	Description
Equals	Returns true if both objects are the same.
GetHashCode	Returns the hashcode of the object.

Properties

Name	Description
Name	The name of the parameter.
SqlType	SQL data type of the parameter. This attribute is only supported for ODBC data sources. For more information, including supported data types, see ISO 9075-3:2008, Table 33 - Codes used for concise data types.
ParameterType	Type of parameter used. If the parameterType=value, then the value from AsBoolean, AsDouble, AsInteger, or AsString are used.In this case, it is expected that only one of those properties is specified.
RefreshOnChange	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).
Prompt	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.
AsBoolean	Boolean value to use as the query parameter. Used only when ParameterType = value.
AsDouble	Non-integer numeric value to use as the query parameter. Used only when ParameterType = value.
AsInteger	Integer value to use as the query parameter. Used when ParameterType = value.
AsString	String value to use as the query parameter. Used only when ParameterType = value.
AsCell	Cell reference indicating which cell's value to use for the query parameter. Used only when ParameterType = cell.