Office development

OLEDBConnection Members (Excel)

GitHub-Mark-64px

Contribute to this content

Use GitHub to suggest and submit changes. See our guidelines for contributing to VBA documentation.

Represents the OLE DB connection.

Name

Description

CancelRefresh

Cancels all refresh operations in progress for the specified OLE DB connection.

MakeConnection

Establishes a connection for the specified OLE DB connection.

Reconnect

Drops and then reconnects the specified connection.

Refresh

Refreshes an OLE DB connection.

SaveAsODC

Saves the OLE DB connection as an Microsoft Office Data Connection file.

Name

Description

ADOConnection

Returns an ADO connection object if the PivotTable cache is connected to an OLE DB data source. Read-only.

AlwaysUseConnectionFile

True if the connection file is always used to establish connection to the data source. Read/write Boolean.

Application

When used without an object qualifier, this property returns an Application object that represents the Microsoft Excel application. When used with an object qualifier, this property returns an Application object that represents the creator of the specified object. Read-only.

BackgroundQuery

True if queries for the OLE DB connection are performed asynchronously (in the background). Read/write Boolean.

CalculatedMembers

Returns the CalculatedMembers collection for the specified connection. Read-only

CommandText

Returns or sets the command string for the specified data source. Read/write Variant.

CommandType

Returns or sets one of the XlCmdType constants. Read/write XlCmdType.

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 Variant.

Creator

Returns a 32-bit integer that indicates the application in which this object was created. Read-only Long.

EnableRefresh

True if the connection can be refreshed by the user. The default value is True. Read/write Boolean.

IsConnected

Returns True if the MaintainConnection property is True. Returns False if it is not currently connected to its source. Read-only Boolean.

LocalConnection

Returns or sets the connection string to an offline cube file. Read/write String.

LocaleID

Returns or sets the locale identifier for the specified connection. Read/write

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.

MaxDrillthroughRecords

Returns or sets the maximum number of records to retrieve. Read/write Long.

OLAP

Returns True if the OLE DB connection is connected to an Online Analytical Processing (OLAP) server. Read-only Boolean.

Parent

Returns the parent object for the specified object. Read-only.

RefreshDate

Returns the date on which the OLE DB connection was last refreshed. Read-only Date.

Refreshing

True if a background OLE DB query is in progress for the specified OLE DB connection. Read/write Boolean.

RefreshOnFileOpen

True if the connection is automatically updated each time the workbook is opened. The default value is False. Read/write Boolean.

RefreshPeriod

Returns or sets the number of minutes between refreshes. Read/write Long.

RetrieveInOfficeUILang

True if the data and errors are to be retrieved in the Office user interface display language when available. Read/write Boolean.

RobustConnect

Returns or sets how OLE DB connection connects to its data source. Read/write XlRobustConnect.

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.

ServerCredentialsMethod

Returns or sets the type of credentials that should be used for server authentication. Read/write XlCredentialsMethod.

ServerFillColor

True if the fill color format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.

ServerFontStyle

True if the font style format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.

ServerNumberFormat

True if the number format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.

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.

ServerTextColor

True if the text color format for the OLAP server is retrieved from the server when using the specified connection. Read/write Boolean.

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.

SourceDataFile

Returns or sets a String indicating the source data file for an OLE DB connection. Read/write.

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.

Show:
© 2016 Microsoft