DataModelConnection
DataModelConnection class
Specifies a data model connection
Properties
| Name | Type | Description |
|---|---|---|
| ClassType | Number | The value of the property is ExternalConnectionClassType integer constant. |
| Command | String | |
| CommandType | Number | The value of the property is OLEDBCommandType integer constant. |
| ConnectionString | String | |
| Id | Number | Gets the id of the connection. |
| ConnectionId | Number | Specifies The unique identifier of this connection. |
| PowerQueryFormula | PowerQueryFormula | Gets the definition of power query formula. |
| Type | ConnectionDataSourceType | Gets or Sets the external connection DataSource type. |
| SourceType | ConnectionDataSourceType | |
| SSOId | String | Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the externa |
| SavePassword | boolean | True if the password is to be saved as part of the connection string; otherwise, False. |
| SaveData | boolean | True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, f |
| RefreshOnLoad | boolean | True if this connection should be refreshed when opening the file; otherwise, false. |
| ReconnectionMethodType | Number | Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodTyp |
| ReconnectionMethod | Number | Specifies what the spreadsheet application should do when a connection fails. The default value is ReConnectionMethodTyp |
| OnlyUseConnectionFile | boolean | Indicates whether the spreadsheet application should always and only use the connection information in the external conn |
| OdcFile | String | Specifies the full path to external connection file from which this connection was created. If a connection fails during |
| SourceFile | String | Used when the external data source is file-based. When a connection to such a data source fails, the spreadsheet applica |
| ConnectionFile | String | |
| IsNew | boolean | True if the connection has not been refreshed for the first time; otherwise, false. This state can happen when the user |
| Name | String | Specifies the name of the connection. Each connection must have a unique name. |
| KeepAlive | boolean | True when the spreadsheet application should make efforts to keep the connection open. When false, the application shoul |
| RefreshInternal | Number | Specifies the number of minutes between automatic refreshes of the connection. |
| ConnectionDescription | String | Specifies the user description for this connection |
| IsDeleted | boolean | Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwis |
| CredentialsMethodType | Number | Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the p |
| Credentials | Number | Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the p |
| BackgroundRefresh | boolean | Indicates whether the connection can be refreshed in the background (asynchronously). true if preferred usage of the con |
| Parameters | ConnectionParameterCollection | Gets ConnectionParameterCollection for an ODBC or web query. |
| SecondCommand | String |
DataModelConnection.ClassType property
The value of the property is ExternalConnectionClassType integer constant.
Type: Number
DataModelConnection.Command property
Type: String
DataModelConnection.CommandType property
The value of the property is OLEDBCommandType integer constant.
Type: Number
DataModelConnection.ConnectionString property
Type: String
DataModelConnection.Id property
Gets the id of the connection.
Type: Number
DataModelConnection.ConnectionId property
Specifies The unique identifier of this connection.
Type: Number
DataModelConnection.PowerQueryFormula property
Gets the definition of power query formula.
Type: PowerQueryFormula
DataModelConnection.Type property
Gets or Sets the external connection DataSource type.
Type: ConnectionDataSourceType
DataModelConnection.SourceType property
Type: ConnectionDataSourceType
DataModelConnection.SSOId property
Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source.
Type: String
DataModelConnection.SavePassword property
True if the password is to be saved as part of the connection string; otherwise, False.
Type: boolean
DataModelConnection.SaveData property
True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false.
Type: boolean
DataModelConnection.RefreshOnLoad property
True if this connection should be refreshed when opening the file; otherwise, false.
Type: boolean
DataModelConnection.ReconnectionMethodType property
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.
Type: Number
DataModelConnection.ReconnectionMethod property
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.
Type: Number
DataModelConnection.OnlyUseConnectionFile property
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
Type: boolean
DataModelConnection.OdcFile property
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.
Type: String
DataModelConnection.SourceFile property
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.
Type: String
DataModelConnection.ConnectionFile property
Type: String
DataModelConnection.IsNew property
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.
Type: boolean
DataModelConnection.Name property
Specifies the name of the connection. Each connection must have a unique name.
Type: String
DataModelConnection.KeepAlive property
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.
Type: boolean
DataModelConnection.RefreshInternal property
Specifies the number of minutes between automatic refreshes of the connection.
Type: Number
DataModelConnection.ConnectionDescription property
Specifies the user description for this connection
Type: String
DataModelConnection.IsDeleted property
Indicates whether the associated workbook connection has been deleted. true if the connection has been deleted; otherwise, false.
Type: boolean
DataModelConnection.CredentialsMethodType property
Specifies the authentication method to be used when establishing (or re-establishing) the connection. The value of the property is CredentialsMethodType integer constant.
Type: Number
DataModelConnection.Credentials property
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.
Type: Number
DataModelConnection.BackgroundRefresh property
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.
Type: boolean
DataModelConnection.Parameters property
Gets ConnectionParameterCollection for an ODBC or web query.
Type: ConnectionParameterCollection
DataModelConnection.SecondCommand property
Type: String