API Reference

Class

LegacyXlsExternalQueryConnection

Namespace OfficeIMO.Excel.LegacyXls.Model
Assembly OfficeIMO.Excel
Modifiers sealed

Describes preserve-only DBQueryExt metadata for an external query table or PivotCache connection.

Inheritance

  • Object
  • LegacyXlsExternalQueryConnection

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Constructors

public LegacyXlsExternalQueryConnection(Int32 recordOffset, UInt16 recordType, String sheetName, UInt16 futureRecordType, UInt16 dataSourceType, LegacyXlsExternalQueryConnectionSourceType sourceTypeKind, String sourceTypeName, UInt16 connectionFlags, UInt16 sourceSpecificFlags, UInt16 queryOptions, Byte editVersion, Byte refreshedVersion, Byte refreshableMinimumVersion, UInt16 oleDbConnectionCount, UInt16 futureByteCount, UInt16 refreshIntervalMinutes, UInt16 htmlFormat, UInt16 parameterFlagCount, Int32 parameterFlagByteCount, Boolean hasCompleteParameterFlags) #

Creates decoded DBQueryExt metadata.

Parameters

recordOffset System.Int32 requiredposition: 0
recordType System.UInt16 requiredposition: 1
sheetName System.String requiredposition: 2
futureRecordType System.UInt16 requiredposition: 3
dataSourceType System.UInt16 requiredposition: 4
sourceTypeKind OfficeIMO.Excel.LegacyXls.Model.LegacyXlsExternalQueryConnectionSourceType requiredposition: 5
sourceTypeName System.String requiredposition: 6
connectionFlags System.UInt16 requiredposition: 7
sourceSpecificFlags System.UInt16 requiredposition: 8
queryOptions System.UInt16 requiredposition: 9
editVersion System.Byte requiredposition: 10
refreshedVersion System.Byte requiredposition: 11
refreshableMinimumVersion System.Byte requiredposition: 12
oleDbConnectionCount System.UInt16 requiredposition: 13
futureByteCount System.UInt16 requiredposition: 14
refreshIntervalMinutes System.UInt16 requiredposition: 15
htmlFormat System.UInt16 requiredposition: 16
parameterFlagCount System.UInt16 requiredposition: 17
parameterFlagByteCount System.Int32 requiredposition: 18
hasCompleteParameterFlags System.Boolean requiredposition: 19

Properties

public Int32 RecordOffset { get; } #

Gets the byte offset of the DBQueryExt BIFF record.

public UInt16 RecordType { get; } #

Gets the BIFF record type.

public String SheetName { get; } #

Gets the worksheet or sheet entry name associated with the record, when known.

public UInt16 FutureRecordType { get; } #

Gets the FrtHeaderOld rt value embedded in the record payload.

public UInt16 DataSourceType { get; } #

Gets the raw DataSourceType value from the DBQueryExt record.

public LegacyXlsExternalQueryConnectionSourceType SourceTypeKind { get; } #

Gets the decoded source type family when the value is known.

public String SourceTypeName { get; } #

Gets the decoded source type name, or a stable raw value for unknown source types.

public UInt16 ConnectionFlags { get; } #

Gets the raw DBQueryExt connection flag bits.

public UInt16 SourceSpecificFlags { get; } #

Gets the raw ConnGrbitDbt source-specific flag bits.

public UInt16 QueryOptions { get; } #

Gets the raw DBQueryExt query option flag bits.

public Boolean MaintainConnection { get; } #

Gets whether the database connection remains open once established.

public Boolean NewQuery { get; } #

Gets whether the connection has not been refreshed.

public Boolean ImportXmlSource { get; } #

Gets whether a Web query imports the underlying XML source instead of a page table.

public Boolean SharePointListSource { get; } #

Gets whether the external connection uses the Web-based SharePoint list provider.

public Boolean SharePointListReinitializeCache { get; } #

Gets whether SharePoint list data is reinitialized instead of refreshed.

public Boolean SourceIsXml { get; } #

Gets whether the external connection source is XML.

public Boolean HasTextWizardQuery { get; } #

Gets whether the DBQueryExt record is followed by a TxtQry record.

public Boolean HasTableNames { get; } #

Gets whether table names are stored in a following ExtString record.

public Byte EditVersion { get; } #

Gets the data functionality level that last edited the connection.

public Byte RefreshedVersion { get; } #

Gets the data functionality level that last refreshed the connection.

public Byte RefreshableMinimumVersion { get; } #

Gets the minimum data functionality level required to refresh the connection.

public UInt16 OleDbConnectionCount { get; } #

Gets the number of OleDbConn records expected to follow this record.

public UInt16 FutureByteCount { get; } #

Gets the declared number of future-version bytes appended to the record.

public UInt16 RefreshIntervalMinutes { get; } #

Gets the automatic refresh interval in minutes. A value of zero disables timed refresh.

public UInt16 HtmlFormat { get; } #

Gets the Web query HTML formatting mode.

public UInt16 ParameterFlagCount { get; } #

Gets the declared count of two-byte PBT parameter flag entries.

public Int32 ParameterFlagByteCount { get; } #

Gets the byte count occupied by PBT parameter flag entries in this record.

public Boolean HasCompleteParameterFlags { get; } #

Gets whether the parameter flag byte count matches the declared PBT count.

public IReadOnlyList<String> ConnectionFlagNames { get; } #

Gets stable names for enabled DBQueryExt connection flags.

public IReadOnlyList<String> QueryOptionNames { get; } #

Gets stable names for enabled DBQueryExt query option flags.