com.aspose.cells
Class ExternalConnection

java.lang.Object
    com.aspose.cells.ExternalConnection

Direct Known Subclasses:

DBConnection, WebQueryConnection

public abstract class ExternalConnection 
extends java.lang.Object

public int getId()

Gets the id of the connection.

public Aspose.Cells.QueryTables.PowerQueryFormula getPowerQueryFormula()

Gets the definition of power query formula.

public int getType() / public void setType(int value)

Gets or Sets the external connection DataSource type. The value of the property is ConnectionDataSourceType integer constant.

public void setType(int value)

public java.lang.String getSourceFile() / public void setSourceFile(java.lang.String value)

Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet application attempts to connect directly to this file. May be expressed in URI or system-specific file path notation.

public void setSourceFile(java.lang.String value)

public java.lang.String getSSOId() / public void setSSOId(java.lang.String value)

Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.

public void setSSOId(java.lang.String value)

public boolean getSavePassword() / public void setSavePassword(boolean value)

True if the password is to be saved as part of the connection string; otherwise, False.

public void setSavePassword(boolean value)

public boolean getSaveData() / public void setSaveData(boolean value)

True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.

public void setSaveData(boolean value)

public boolean getRefreshOnLoad() / public void setRefreshOnLoad(boolean value)

True if this connection should be refreshed when opening the file; otherwise, false.

public void setRefreshOnLoad(boolean value)

public int getReconnectionMethodType() / public void setReconnectionMethodType(int value)

Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.

public void setReconnectionMethodType(int value)

public int getReconnectionMethod() / public void setReconnectionMethod(int value)

Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required. The value of the property is ReConnectionMethodType integer constant.

NOTE: This property is now obsolete. Instead, please use ExternalConnection.ReconnectionMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.

public void setReconnectionMethod(int value)

public boolean getOnlyUseConnectionFile() / public void setOnlyUseConnectionFile(boolean value)

Indicates whether the spreadsheet application should always and only use the connection information in the external connection file indicated by the odcFile attribute when the connection is refreshed. If false, then the spreadsheet application should follow the procedure indicated by the reconnectionMethod attribute

public void setOnlyUseConnectionFile(boolean value)

public java.lang.String getOdcFile() / public void setOdcFile(java.lang.String value)

Specifies the full path to external connection file from which this connection was created. If a connection fails during an attempt to refresh data, and reconnectionMethod=1, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook.

public void setOdcFile(java.lang.String value)

public boolean isNew() / public void setNew(boolean value)

True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user saves the file before a query has finished returning.

public void setNew(boolean value)

public java.lang.String getName() / public void setName(java.lang.String value)

Specifies the name of the connection. Each connection must have a unique name.

public void setName(java.lang.String value)

public boolean getKeepAlive() / public void setKeepAlive(boolean value)

True when the spreadsheet application should make efforts to keep the connection open. When false, the application should close the connection after retrieving the information.

public void setKeepAlive(boolean value)

public int getRefreshInternal() / public void setRefreshInternal(int value)

Specifies the number of minutes between automatic refreshes of the connection.

public void setRefreshInternal(int value)

public int getConnectionId()

Specifies The unique identifier of this connection.

public java.lang.String getConnectionDescription() / public void setConnectionDescription(java.lang.String value)

Specifies the user description for this connection

public void setConnectionDescription(java.lang.String value)

public boolean isDeleted() / public void setDeleted(boolean value)

Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.

public void setDeleted(boolean value)

public int getCredentialsMethodType() / public void setCredentialsMethodType(int value)

Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.

public void setCredentialsMethodType(int value)

public int getCredentials() / public void setCredentials(int value)

Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.

NOTE: This property is now obsolete. Instead, please use ExternalConnection.CredentialsMethodType property. This property will be removed 12 months later since October 2017. Aspose apologizes for any inconvenience you may have experienced.

public void setCredentials(int value)

public boolean getBackgroundRefresh() / public void setBackgroundRefresh(boolean value)

Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the connection is to refresh asynchronously in the background; false if preferred usage of the connection is to refresh synchronously in the foreground.

public void setBackgroundRefresh(boolean value)

public ConnectionParameterCollection getParameters()

Gets ConnectionParameterCollection for an ODBC or web query.