com.aspose.cells.ConnectionParameter.html Maven / Gradle / Ivy
ConnectionParameter
com.aspose.cells
Class ConnectionParameter
java.lang.Object
com.aspose.cells.ConnectionParameter
public class ConnectionParameter
- extends java.lang.Object
| Property Getters/Setters Summary | ||
|---|---|---|
java.lang.String | getCellReference() | |
void | setCellReference(java.lang.String) | |
| Cell reference indicating which cell's value to use for the query parameter. Used only when parameterType is cell. | ||
java.lang.String | getName() | |
void | setName(java.lang.String) | |
| The name of the parameter. | ||
java.lang.String | getPrompt() | |
void | setPrompt(java.lang.String) | |
| 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. | ||
boolean | getRefreshOnChange() | |
void | setRefreshOnChange(boolean) | |
| 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). | ||
int | getSqlType() | |
void | setSqlType(int) | |
| SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant. | ||
int | getType() | |
void | setType(int) | |
| 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. The value of the property is ConnectionParameterType integer constant. | ||
java.lang.Object | getValue() | |
void | setValue(java.lang.Object) | |
| 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 | |
public int getSqlType() / public void setSqlType(int value) | |
SQL data type of the parameter. Only valid for ODBC sources. The value of the property is SqlDataType integer constant.
getRefreshOnChange/setRefreshOnChange | |
public boolean getRefreshOnChange() / 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/setPrompt | |
public java.lang.String getPrompt() / 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/setType | |
public int getType() / 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. The value of the property is ConnectionParameterType integer constant.
getName/setName | |
public java.lang.String getName() / public void setName(java.lang.String value) | |
The name of the parameter.
getCellReference/setCellReference | |
public java.lang.String getCellReference() / 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/setValue | |
public java.lang.Object getValue() / 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.
See Also:
Aspose.Cells Documentation - the home page for the Aspose.Cells Product Documentation.
Aspose.Cells Support Forum - our preferred method of support.