Connection 类

定义

命名空间:

DocumentFormat.OpenXml.Spreadsheet

程序集:

DocumentFormat.OpenXml.dll

包:

DocumentFormat.OpenXml v3.0.1

连接。

此类在 Office 2007 及更高版本中可用。

将对象序列化为 xml 时，其限定名称为 x：connection。

public class Connection : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Connection = class
    inherit OpenXmlCompositeElement

Public Class Connection
Inherits OpenXmlCompositeElement

继承

Object

OpenXmlElement

OpenXmlCompositeElement

Connection

注解

[ISO/IEC 29500-1 第 1 版]

连接 (连接)

此元素包含如何访问外部数据源的定义，以及描述如何在工作簿中使用连接的信息。 工作表中的特定构造（如 OLAP 公式、QueryTable 或数据透视表）利用连接中的信息来根据默认事件或用户的显式请求检索或刷新数据。

父元素
connections (§18.13.2)

子元素	第
dbPr (数据库属性)	§18.13.3
extLst (Future Feature Data Storage Area)	§18.2.10
olapPr (OLAP 属性)	§18.13.5
参数 (查询参数)	§18.13.7
textPr (文本导入设置)	§18.13.12
webPr (Web 查询属性)	§18.13.13

属性	说明
后台 (后台刷新)	指示是否可以在后台 (异步) 刷新连接。 如果连接的首选用法是在后台异步刷新，则为 true;如果连接的首选用法是在前台同步刷新，则为 false。 在特定情况下，应有意忽略此标志。 [示例：在连接到 Microsoft SQL Server Analysis Services 上的 OLAP 数据的情况下，将忽略标志的一个示例，其中数据透视表和工作簿中的 CUBE 函数都使用该连接。 该连接将始终由数据透视表同步刷新，并且始终由 CUBE 函数异步刷新。 示例结束] 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
凭据 (重新连接方法)	指定在建立 (或重新建立) 连接时使用的身份验证方法。 此属性的可能值由 ST_CredMethod 简单类型 (§18.18.16) 定义。
deleted (Deleted Connection)	指示是否已删除关联的工作簿连接。 如果连接已删除，则为 true;否则为 false。 已删除的连接仅包含属性名称，deleted=true，所有其他信息将从 SpreadsheetML 文件中删除。 如果创建的新连接与已删除的连接同名，则新连接将覆盖已删除的连接。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
说明 (连接说明)	指定此连接的用户说明。 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。
id (连接 ID)	指定此连接的唯一标识符。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。
interval (自动刷新间隔)	指定连接自动刷新之间的分钟数。 如果此属性不存在，则不会自动刷新连接。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。
keepAlive (保持连接打开)	如果电子表格应用程序应努力保持连接打开状态，则为 true。 如果 为 false，则应用程序应在检索信息后关闭连接。 这对应于 PivotCache 对象的 MaintainConnection 属性。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
minRefreshableVersion (刷新) 所需的最低版本	为了与旧版电子表格应用程序兼容。 这表示能够正确刷新数据连接所需的最低版本 #。 此属性适用于 QueryTable 使用的连接。 此属性的可能值由 W3C XML 架构 unsignedByte 数据类型定义。
名称 (连接名称)	指定连接的名称。 每个连接应具有唯一的名称。 当连接标记为已删除，然后添加具有相同名称的新连接时，已删除的连接将替换为新连接。 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。
新 (新连接)	如果第一次未刷新连接，则为 true;否则为 false。 当用户在查询完成返回之前保存文件时，可能会发生此状态。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
odcFile (连接文件)	指定从中创建此连接的外部连接文件的完整路径。 如果在尝试刷新数据期间连接失败，并且重新连接Method=1，则电子表格应用程序将使用外部连接文件中的信息（而不是工作簿中嵌入的连接对象）重试。 这有利于数据源和电子表格ML 文档的可管理性。 如果外部连接文件中的定义 (更改，例如，由于数据库服务器名称) 更改，则使用该连接的工作簿将无法使用其内部连接信息进行连接，并从此文件重新加载新的连接信息。 当用户手动编辑工作簿中的连接定义时，电子表格应用程序会清除此属性。 可以用 或特定于系统的文件路径表示法表示。 [注意：应用程序可以决定它们支持哪些形式，以及是否支持特定于系统的文件路径表示法。 注释结束] 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。
onlyUseConnectionFile (仅使用连接文件)	指示电子表格应用程序在刷新连接时是否应始终且仅使用 odcFile 属性指示的外部连接文件中的连接信息。 如果 为 false，则电子表格应用程序应遵循下面所述的 reconnectionMethod 属性指示的过程。 仅适用于 OLE DB 和 ODBC 连接，对于其他类型的连接，此属性将被忽略。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
reconnectionMethod (重新连接方法)	指定在连接失败时电子表格应用程序应执行的操作。 有以下值： 1 = 根据需要：刷新时使用现有连接信息。 如果现有信息不能用于建立连接，请从外部连接文件获取更新的连接信息（如果可用）。 2 = 始终：每次刷新时，从外部连接文件获取更新的连接信息（如果可用），并使用它而不是现有的连接信息。 在这种情况下，如果外部连接文件不可用，则数据刷新将失败。 3 = 从不：即使外部连接文件可用且无法使用现有连接信息，也永远不要从外部连接文件获取更新的连接信息。 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。
refreshedVersion (上次刷新版本)	为了向后兼容，此属性指示上次刷新连接的电子表格应用程序版本。 此属性适用于查询表使用的连接。 此属性的可能值由 W3C XML 架构 unsignedByte 数据类型定义。
refreshOnLoad (打开) 刷新	如果打开文件时应刷新此连接，则为 true;否则为 false。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
saveData (Save Data)	如果通过连接提取以填充表的外部数据是随工作簿一起保存的，则为 true;否则为 false。 出于数据安全目的，如果工作簿中的 (或“缓存”) 中没有保存外部数据，则每次检索相关数据都需要当前用户凭据，并且用户在保存文件之前不会看到工作簿作者上次使用的数据。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
savePassword (保存密码)	如果要将密码保存为连接字符串的一部分，则为 true;否则为 False。 此属性可能的值由 W3C XML 架构 boolean 数据类型定义。
singleSignOnId (SSO Id)	单一登录 (SSO) 标识符，用于中间 spreadsheetML 服务器和外部数据源之间的身份验证。 [注意：数据连接可以使用许多不同的技术。 可在以下位置找到存储在此属性中的潜在值的一个示例： http://msdn.microsoft.com/library/default.asp?url=/library/en-us/spptsdk/html/cSSOReturnCodes_SV01001109.asp结尾注释] 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。
sourceFile (源数据库文件)	当外部数据源基于文件时使用。 当与此类数据源的连接失败时，电子表格应用程序将尝试直接连接到此文件。 可以用 或特定于系统的文件路径表示法表示。 [注意：应用程序可以决定它们支持哪些形式，以及是否支持特定于系统的文件路径表示法。 注释结束] 此属性的可能值由 ST_Xstring 简单类型 (§22.9.2.19) 定义。
类型 (数据库源类型)	指定数据源类型。 值如下： 1. 基于 ODBC 的源 2. 基于 DAO 的源 3.基于文件的数据库源 4. Web 查询 5. 基于 OLE DB 的源 6. 基于文本的源 7. 记录集 8. DSP 此属性的可能值由 W3C XML 架构 unsignedInt 数据类型定义。

[注意：此元素的内容模型 (CT_Connection) 的 W3C XML 架构定义位于 §A.2 中。 注释结束]

ISO/IEC29500：2008。

构造函数

Connection()	初始化 Connection 类的新实例。
Connection(IEnumerable<OpenXmlElement>)	使用指定的子元素初始化 Connection 类的新实例。
Connection(OpenXmlElement[])	使用指定的子元素初始化 Connection 类的新实例。
Connection(String)	从外部 XML 初始化 Connection 类的新实例。

属性

Background	背景 表示架构中的以下属性：background
ChildElements	获取当前元素的所有子节点。 (继承自 OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList。 表示架构中的以下元素标记：x：extLst。
ConnectionFile	odcFile 表示架构中的以下属性：odcFile
Credentials	凭据 表示架构中的以下属性：凭据
DatabaseProperties	DatabaseProperties。 表示架构中的以下元素标记：x：dbPr。
Deleted	deleted 表示架构中的以下属性：deleted
Description	说明 表示架构中的以下属性：description
ExtendedAttributes	获取当前元素的架构) 中未定义的所有扩展属性 (属性。 (继承自 OpenXmlElement)
Features	IFeatureCollection获取当前元素的 。 此功能集合将是只读的，但会从其父部件和包继承功能（如果可用）。 (继承自 OpenXmlElement)
FirstChild	获取当前 OpenXmlElement 元素的第一个子元素。 (继承自 OpenXmlCompositeElement)
HasAttributes	获取一个值，该值指示当前元素是否具有任何属性。 (继承自 OpenXmlElement)
HasChildren	获取一个值，该值指示当前元素是否具有任何子元素。 (继承自 OpenXmlCompositeElement)
Id	id 表示架构中的以下属性：id
InnerText	获取或设置当前节点及其所有子节点的串联值。 (继承自 OpenXmlCompositeElement)
InnerXml	获取或设置仅表示当前节点的子节点的标记。 (继承自 OpenXmlCompositeElement)
Interval	interval 表示架构中的以下属性：interval
KeepAlive	keepAlive 表示架构中的以下属性：keepAlive
LastChild	获取当前 OpenXmlElement 元素的最后一个子元素。 如果没有这样的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlCompositeElement)
LocalName	获取当前元素的本地名称。 (继承自 OpenXmlElement)
MCAttributes	获取或设置标记兼容性属性。 如果未为当前元素定义标记兼容性属性，则返回 null。 (继承自 OpenXmlElement)
MinRefreshableVersion	minRefreshableVersion 表示架构中的以下属性：minRefreshableVersion
Name	name 表示架构中的以下属性：name
NamespaceDeclarations	获取在当前元素中定义的所有命名空间声明。 如果没有命名空间声明，则返回空枚举器。 (继承自 OpenXmlElement)
NamespaceUri	获取当前元素的命名空间 URI。 (继承自 OpenXmlElement)
New	新增功能 表示架构中的以下属性：new
OlapProperties	OlapProperties。 表示架构中的以下元素标记：x：olapPr。
OnlyUseConnectionFile	onlyUseConnectionFile 表示架构中的以下属性：onlyUseConnectionFile
OpenXmlElementContext	获取当前元素的 OpenXmlElementContext。 (继承自 OpenXmlElement)
OuterXml	获取表示当前元素及其所有子元素的标记。 (继承自 OpenXmlElement)
Parameters	参数。 表示架构中的以下元素标记：x：parameters。
Parent	获取当前元素的父元素。 (继承自 OpenXmlElement)
Prefix	获取当前元素的命名空间前缀。 (继承自 OpenXmlElement)
ReconnectionMethod	reconnectionMethod 表示架构中的以下属性：reconnectionMethod
RefreshedVersion	refreshedVersion 表示架构中的以下属性：refreshedVersion
RefreshOnLoad	refreshOnLoad 表示架构中的以下属性：refreshOnLoad
SaveData	saveData 表示架构中的以下属性：saveData
SavePassword	savePassword 表示架构中的以下属性：savePassword
SingleSignOnId	singleSignOnId 表示架构中的以下属性：singleSignOnId
SourceFile	sourceFile 表示架构中的以下属性：sourceFile
TextProperties	TextProperties。 表示架构中的以下元素标记：x：textPr。
Type	type 表示架构中的以下属性：类型
WebQueryProperties	WebQueryProperties。 表示架构中的以下元素标记：x：webPr。
XmlQualifiedName	获取当前元素的限定名称。 (继承自 OpenXmlElement)
XName	获取当前元素的限定名称。 (继承自 OpenXmlElement)

方法

AddAnnotation(Object)	将 对象添加到当前 OpenXmlElement 元素的批注列表中。 (继承自 OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	如果指定元素是已知的子元素，则将其添加到 元素。 这会根据架构将 元素添加到正确的位置。 (继承自 OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	将命名空间声明添加到当前节点。 (继承自 OpenXmlElement)
Ancestors()	枚举当前元素的所有上级。 (继承自 OpenXmlElement)
Ancestors<T>()	仅枚举具有指定类型的当前元素的上级。 (继承自 OpenXmlElement)
Annotation(Type)	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotation<T>()	从当前 OpenXmlElement 元素获取指定类型的第一个批注对象。 (继承自 OpenXmlElement)
Annotations(Type)	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Annotations<T>()	获取具有当前 OpenXmlElement 元素的指定类型的批注的集合。 (继承自 OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	将元素列表中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
Append(OpenXmlElement[])	将元素数组中的每个元素追加到当前元素的子元素列表的末尾。 (继承自 OpenXmlElement)
AppendChild<T>(T)	将指定的元素追加到当前元素的子节点列表的末尾。 (继承自 OpenXmlCompositeElement)
ClearAllAttributes()	清除所有属性，包括已知属性和扩展属性。 (继承自 OpenXmlElement)
Clone()	创建当前节点的副本。 (继承自 OpenXmlElement)
CloneNode(Boolean)	创建此节点的副本。
Descendants()	枚举当前元素的所有后代。 (继承自 OpenXmlElement)
Descendants<T>()	枚举类型为 T 的当前元素的所有后代。 (继承自 OpenXmlElement)
Elements()	枚举当前元素的所有子元素。 (继承自 OpenXmlElement)
Elements<T>()	仅枚举具有指定类型的当前元素的子元素。 (继承自 OpenXmlElement)
ElementsAfter()	枚举与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
ElementsBefore()	枚举当前元素之前且具有与当前元素相同的父级的所有同级元素。 (继承自 OpenXmlElement)
GetAttribute(String, String)	获取具有指定标记名称和命名空间 URI 的 Open XML 属性。 (继承自 OpenXmlElement)
GetAttributes()	获取一个列表，该列表包含所有属性的副本。 (继承自 OpenXmlElement)
GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)
GetFirstChild<T>()	查找类型 T 中的第一个子元素。 (继承自 OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	在指定的引用元素之后立即插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	在当前元素之后立即插入指定的元素。 (继承自 OpenXmlElement)
InsertAt<T>(T, Int32)	在当前元素的子元素的指定索引处插入指定的元素。 (继承自 OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	将指定的元素紧接在指定的引用元素之前。 (继承自 OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	将指定的元素紧接在当前元素的前面。 (继承自 OpenXmlElement)
IsAfter(OpenXmlElement)	确定当前元素是否以文档顺序显示在指定元素之后。 (继承自 OpenXmlElement)
IsBefore(OpenXmlElement)	确定当前元素是否按文档顺序显示在指定元素之前。 (继承自 OpenXmlElement)
LookupNamespace(String)	解析当前节点上下文中的命名空间前缀。 (继承自 OpenXmlElement)
LookupPrefix(String)	查找当前元素范围内命名空间 URI 的相应前缀。 (继承自 OpenXmlElement)
NextSibling()	获取紧跟在当前 OpenXmlElement 元素后面的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
NextSibling<T>()	获取具有当前 OpenXmlElement 元素后面的指定类型的 OpenXmlElement 元素。 如果没有下一个 OpenXmlElement，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
PrependChild<T>(T)	在当前元素的子节点列表的开头插入指定的元素。 (继承自 OpenXmlCompositeElement)
PreviousSibling()	获取紧接在当前 OpenXmlElement 元素之前的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic ) 中 Nothing。 (继承自 OpenXmlElement)
PreviousSibling<T>()	获取位于当前 OpenXmlElement 之前的指定类型的 OpenXmlElement 元素。 如果没有前面的 OpenXmlElement 元素，则返回 null (Visual Basic) Nothing。 (继承自 OpenXmlElement)
Remove()	从其父元素中删除当前元素。 (继承自 OpenXmlElement)
RemoveAllChildren()	删除当前元素的所有子元素。 (继承自 OpenXmlCompositeElement)
RemoveAllChildren<T>()	删除类型为 T 的当前元素的所有子元素。 (继承自 OpenXmlElement)
RemoveAnnotations(Type)	从当前 OpenXmlElement 元素中删除指定类型的注释。 (继承自 OpenXmlElement)
RemoveAnnotations<T>()	从当前 OpenXmlElement 元素中删除具有指定类型的批注。 (继承自 OpenXmlElement)
RemoveAttribute(String, String)	从当前元素中删除 属性。 (继承自 OpenXmlElement)
RemoveChild<T>(T)	删除指定的子元素。 (继承自 OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	删除指定前缀的命名空间声明。 如果没有前缀，则不删除任何内容。 (继承自 OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	将当前元素的子元素之一替换为另一个 OpenXmlElement 元素。 (继承自 OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	将特性设置为指定的元素。 如果该属性是已知属性，则设置该特性的值。 如果该属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	设置元素的多个属性。 如果属性是已知属性，则会设置该属性的值。 如果属性是扩展属性，则会将“openxmlAttribute”添加到扩展属性列表中。 (继承自 OpenXmlElement)
WriteTo(XmlWriter)	将当前节点保存到指定的 XmlWriter。 (继承自 OpenXmlElement)

显式接口实现

IEnumerable.GetEnumerator()	连接。 此类在 Office 2007 及更高版本中可用。 将对象序列化为 xml 时，其限定名称为 x：connection。 (继承自 OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	返回循环访问子集合的枚举器。 (继承自 OpenXmlElement)