Share via


OLEDBConnection Members

Include Protected Members
Include Inherited Members

Represents the OLE DB connection.

The OLEDBConnection type exposes the following members.

Properties

  Name Description
Public property ADOConnection Returns an ADO connection object if the PivotTable cache is connected to an OLE DB data source. Read-only.
Public property AlwaysUseConnectionFile Trueif the connection file is always used to establish connection to the data source. Read/write Boolean.
Public property Application When used without an object qualifier, this property returns an _Application object that represents the Microsoft Office Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object. Read-only.
Public property BackgroundQuery True if queries for the OLE DB connection are performed asynchronously (in the background). Read/write Boolean.
Public property CalculatedMembers Gets the CalculatedMembers collection for the specified connection.
Public property CommandText Returns or sets the command string for the specified data source. Read/write Object.
Public property CommandType Returns or sets one of the XlCmdType constants. Read/write XlCmdType.
Public property Connection Returns or sets a string that contains OLE DB settings that enable Microsoft Excel to connect to an OLE DB data source. Read/write Object.
Public property Creator Returns a constant in the XlCreator enumeration that indicates the application in which this object was created. Read-only.
Public property EnableRefresh True if the connection can be refreshed by the user. The default value is True. Read/write Boolean.
Public property IsConnected Returns True if the MaintainConnection property isTrue. Returns False if it is not currently connected to its source. Read-only Boolean.
Public property LocalConnection Returns or sets the connection string to an offline cube file. Read/write Object.
Public property LocaleID Gets or sets the locale identifier for the specified connection.
Public property MaintainConnection Returns True if the connection to the specified data source is maintained after the refresh operation and until the workbook is closed. Read/write Boolean.
Public property MaxDrillthroughRecords Returns or sets the maximum number of records to retrieve. Read/write Integer.
Public property OLAP Returns True if the OLE DB connection is connected to an Online Analytical Processing (OLAP) server. Read-only Boolean.
Public property Parent Returns the parent object for the specified object. Read-only.
Public property RefreshDate Returns the date on which the OLE DB connection was last refreshed. Read-only DateTime.
Public property Refreshing True if a background OLE DB query is in progress for the specified OLE DB connection. Read/write Boolean.
Public property RefreshOnFileOpen True if the connection is automatically updated each time the workbook is opened. The default value is False. Read/write Boolean.
Public property RefreshPeriod Returns or sets the number of minutes between refreshes. Read/write Integer.
Public property RetrieveInOfficeUILang True if the data and errors are to be retrieved in the Office user interface display language when available. Read/write Boolean.
Public property RobustConnect Returns or sets how OLE DB connection connects to its data source. Read/write XlRobustConnect.
Public property SavePassword True if password information in an OLE DB connection string is saved in the connection string. False if the password is removed. Read/write Boolean.
Public property ServerCredentialsMethod Returns or sets the type of credentials that should be used for server authentication. Read/write XlCredentialsMethod.
Public property ServerFillColor True if the fill color format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.
Public property ServerFontStyle True if the font style format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.
Public property ServerNumberFormat True if the number format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.
Public property ServerSSOApplicationID Returns or sets a single sign-on application (SSO) identifier that is used to perform a lookup in the SSO database for credentials. Read/write String.
Public property ServerTextColor True if the text color format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.
Public property SourceConnectionFile Returns or sets a String indicating the Microsoft Office Data Connection file or similar file that was used to create the connection. Read/write.
Public property SourceDataFile Returns or sets a String indicating the source data file for an OLE DB connection. Read/write.
Public property UseLocalConnection True if the LocalConnection property is used to specify the string that enables Microsoft Excel to connect to a data source. False if the connection string specified by the Connection property is used. Read/write Boolean.

Top

Methods

  Name Description
Public method CancelRefresh Cancels all refresh operations in progress for the specified OLE DB connection.
Public method MakeConnection Establishes a connection for the specified OLE DB connection.
Public method Reconnect Drops and then reconnects the specified connection.
Public method Refresh Refreshes an OLE DB connection.
Public method SaveAsODC Saves the OLE DB connection as an Microsoft Office Data Connection file.

Top

See Also

Reference

OLEDBConnection Interface

Microsoft.Office.Interop.Excel Namespace