TDataConnection Class
This class represents one data connection on the workbook.
Syntax
Unit: FlexCel.Core
TDataConnection = class(TFlexCelObject);
Methods
Name | Description |
---|---|
Equals | Returns true if obj is the same as this object. |
GetHashCode | Returns the hashcode of the object. |
Properties
Name | Description |
---|---|
DbProperties | This element stores all properties associated with an ODBC or OLE DB external data connection. |
OlapProperties | This element contains all the properties needed for an OLAP data connection. OLAP connections contain both the TDataConnectionDbProperties and TDataConnectionOlapProperties child elements. |
WebQueryProperties | This element specifies the properties for a web query source. A web query will retrieve data from HTML tables, and can also supply HTTP "Get" parameters to be processed by the web server in generating the HTML by including the parameters and parameter elements. |
TextImportProperties | This element contains all of the text import settings. |
Parameters | This element stores properties about any parameters used with external data connections. Parameters are used to change the query executed externally and cause different data to be retrieved into the workbook.The type of parameter used determines whether the user is prompted for a value before data is refreshed, or the value is pulled from a cell in the workbook, or whether the same value should be used until explicitly changed in the data connection. Parameters are permitted for ODBC and web queries. |
ID | Specifies The unique identifier of this connection. |
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. Can be expressed in URI or system-specific file path notation. |
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 is AsRequired, then the spreadsheet application will try again using information from the external connection file instead of the connection object embedded within the workbook. |
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. |
Interval | Specifies the number of minutes between automatic refreshes of the connection. When this attribute is not present, the connection is not automatically refreshed. |
Name | Specifies the name of the connection. Each connection shall have a unique name. |
Description | Specifies the user description for this connection. |
ConnectionType | Specifies the data source type. |
ReconnectionMethod | Specifies what the spreadsheet application should do when a connection fails. |
RefreshedVersion | For backward compatibility purposes, this attribute indicates the version of the spreadsheet application that last refreshed the connection. |
MinRefreshableVersion | For compatibility with legacy spreadsheet applications. This represents the minimum version # that is required to be able to correctly refresh the data connection. |
SavePassword | True if the password is to be saved as part of the connection string |
IsNew | True if the connection has not been refreshed for the first time. This can happen when the user saves the file before a query has finished returning. |
Deleted | Indicates whether the associated workbook connection has been deleted. Deleted connections contain only the attributes name and deleted=true, all other information is removed when saving the file. If a new connection is created with the same name as a deleted connection, then the deleted connection is overwritten by the new connection. |
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. Applies to ODBC connections, and may be applied to custom data connections.This attribute is ignored for other types of connections. |
SingleSignOnId | Identifier for Single Sign On (SSO) used for authentication between an intermediate spreadsheetML server and the external data source. |
Credentials | Specifies the authentication method to be used when establishing (or re-establishing) the connection. |
SaveData | True if the external data fetched over the connection to populate a table is to be saved with the workbook; otherwise, false. This exists for data security purposes - if no external data is saved in (or "cached") in the workbook, then current user credentials can be required every time to retrieve the relevant data, and people won't see the data the workbook author had last been using before saving the file. |
RefreshOnLoad | True if this connection should be refreshed when opening the file. |
Background | 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. |