Class ExternalConnection
Namespace: Aspose.Cells.ExternalConnections
Assembly: Aspose.Cells.dll (25.2.0)
Specifies an external data connection
public abstract class ExternalConnectionInheritance
Derived
DBConnection, DataModelConnection, WebQueryConnection
Inherited Members
object.GetType(), object.MemberwiseClone(), object.ToString(), object.Equals(object?), object.Equals(object?, object?), object.ReferenceEquals(object?, object?), object.GetHashCode()
Properties
BackgroundRefresh
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 bool BackgroundRefresh { get; set; }Property Value
ClassType
Gets the type of this Aspose.Cells.ExternalConnections.ExternalConnection object.
public abstract ExternalConnectionClassType ClassType { get; }Property Value
Command
The string containing the database command to pass to the data provider API that will interact with the external source in order to retrieve data
public virtual string Command { get; set; }Property Value
CommandType
Specifies the OLE DB command type.
- Query specifies a cube name
- Query specifies a SQL statement
- Query specifies a table name
- Query specifies that default information has been given, and it is up to the provider how to interpret.
- Query is against a web based List Data Provider.
public virtual OLEDBCommandType CommandType { get; set; }Property Value
ConnectionDescription
Specifies the user description for this connection
public string ConnectionDescription { get; set; }Property Value
ConnectionFile
Gets the connection file.
public virtual string ConnectionFile { get; }Property Value
ConnectionString
The connection information string is used to make contact with an OLE DB or ODBC data source.
public virtual string ConnectionString { get; set; }Property Value
CredentialsMethodType
Specifies the authentication method to be used when establishing (or re-establishing) the connection.
public CredentialsMethodType CredentialsMethodType { get; set; }Property Value
Id
Gets the id of the connection.
public int Id { get; }Property Value
IsDeleted
Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
public bool IsDeleted { get; set; }Property Value
IsNew
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 bool IsNew { get; set; }Property Value
KeepAlive
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 bool KeepAlive { get; set; }Property Value
Name
Specifies the name of the connection. Each connection must have a unique name.
public string Name { get; set; }Property Value
OdcFile
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 string OdcFile { get; set; }Property Value
OnlyUseConnectionFile
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 bool OnlyUseConnectionFile { get; set; }Property Value
Parameters
Gets Aspose.Cells.ExternalConnections.ConnectionParameterCollection for an ODBC or web query.
public ConnectionParameterCollection Parameters { get; }Property Value
PowerQueryFormula
Gets the definition of power query formula.
public virtual PowerQueryFormula PowerQueryFormula { get; }Property Value
ReconnectionMethodType
Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodType.Required.
public ReConnectionMethodType ReconnectionMethodType { get; set; }Property Value
RefreshInternal
Specifies the number of minutes between automatic refreshes of the connection.
public int RefreshInternal { get; set; }Property Value
RefreshOnLoad
True if this connection should be refreshed when opening the file; otherwise, false.
public bool RefreshOnLoad { get; set; }Property Value
SSOId
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
public string SSOId { get; set; }Property Value
SaveData
True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
public bool SaveData { get; set; }Property Value
SavePassword
True if the password is to be saved as part of the connection string; otherwise, False.
public bool SavePassword { get; set; }Property Value
SecondCommand
Specifies a second command text string that is persisted when PivotTable server-based page fields are in use. For ODBC connections, serverCommand is usually a broader query than command (no WHERE clause is present in the former). Based on these 2 commands(Command and ServerCommand), parameter UI can be populated and parameterized queries can be constructed
public virtual string SecondCommand { get; set; }Property Value
SourceFile
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 string SourceFile { get; set; }Property Value
SourceType
Gets or Sets the external connection DataSource type.
public ConnectionDataSourceType SourceType { get; set; }