Class ConnectionParameter
Namespace: Aspose.Cells.ExternalConnections
Assembly: Aspose.Cells.dll (25.2.0)
Specifies properties about any parameters used with external data connections Parameters are valid for ODBC and web queries.
public class ConnectionParameterInheritance
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Properties
CellReference
Cell reference indicating which cell’s value to use for the query parameter. Used only when parameterType is cell.
public string CellReference { get; set; }Property Value
Name
The name of the parameter.
public string Name { get; set; }Property Value
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.
public string Prompt { get; set; }Property Value
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).
public bool RefreshOnChange { get; set; }Property Value
SqlType
SQL data type of the parameter. Only valid for ODBC sources.
public SqlDataType SqlType { get; set; }Property Value
Type
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.
public ConnectionParameterType Type { get; set; }Property Value
Value
Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.
public object Value { get; set; }