aspose.cells

Class ConnectionParameter

Specifies properties about any parameters used with external data connections Parameters are valid for ODBC and web queries.

Property Getters/Setters Summary
functiongetCellReference()
function
           Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
functiongetName()
function
setName(value)
           The name of the parameter.
functiongetPrompt()
function
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.
functiongetRefreshOnChange()
function
           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).
functiongetSqlType()
function
setSqlType(value)
           SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
functiongetType()
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.
functiongetValue()
function
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.
 

    • Property Getters/Setters Detail

      • getSqlType/setSqlType : Number 

        function getSqlType() / function setSqlType(value)
        
        SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
      • getRefreshOnChange/setRefreshOnChange : boolean 

        function getRefreshOnChange() / function 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).
      • getPrompt/setPrompt : String 

        function getPrompt() / function 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.
      • getType : ConnectionParameterType 

        function 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.
      • getName/setName : String 

        function getName() / function setName(value)
        
        The name of the parameter.
      • getCellReference/setCellReference : String 

        function getCellReference() / function setCellReference(value)
        
        Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.
      • getValue/setValue : Object 

        function getValue() / function 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.