com.aspose.cells

Class ConnectionParameter

java.lang.Object

com.aspose.cells.ConnectionParameter

public class ConnectionParameter
extends java.lang.Object

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

Method Summary

Methods

Modifier and Type	Method and Description
java.lang.String	getCellReference() Cell reference indicating which cell's value to use for the query parameter.
java.lang.String	getName() The name of the parameter.
java.lang.String	getPrompt() Prompt string for the parameter.
boolean	getRefreshOnChange() Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes.
int	getSqlType() SQL data type of the parameter.
int	getType() Type of parameter used.
java.lang.Object	getValue() Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter.
void	setCellReference(java.lang.String value) Cell reference indicating which cell's value to use for the query parameter.
void	setName(java.lang.String value) The name of the parameter.
void	setPrompt(java.lang.String value) Prompt string for the parameter.
void	setRefreshOnChange(boolean value) Flag indicating whether the query should automatically refresh when the contents of a cell that provides the parameter value changes.
void	setSqlType(int value) SQL data type of the parameter.
void	setType(int value) Type of parameter used.
void	setValue(java.lang.Object value) Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getSqlType

public int getSqlType()

SQL data type of the parameter. Only valid for ODBC sources.

See SqlDataType.

setSqlType

public void setSqlType(int value)

SQL data type of the parameter. Only valid for ODBC sources.

See SqlDataType.

getRefreshOnChange

public boolean 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).

setRefreshOnChange

public void setRefreshOnChange(boolean 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

public java.lang.String 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.

setPrompt

public void setPrompt(java.lang.String 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

public int 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.

See ConnectionParameterType.

setType

public void setType(int 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.

See ConnectionParameterType.

getName

public java.lang.String getName()

The name of the parameter.

setName

public void setName(java.lang.String value)

The name of the parameter.

getCellReference

public java.lang.String getCellReference()

Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.

setCellReference

public void setCellReference(java.lang.String value)

Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell.

getValue

public java.lang.Object getValue()

Non-integer numeric value,Integer value,String value or Boolean value to use as the query parameter. Used only when parameterType is value.

setValue

public void setValue(java.lang.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.