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 издание]

connection (Connection)

Этот элемент содержит как определение способа получения во внешнем источнике данных, так и сведения, описывающие, как соединение используется в книге. Определенные конструкции на листе, такие как формулы OLAP, таблицы запросов или сводные таблицы, используют сведения в соединении для получения или обновления данных на основе событий по умолчанию или явного запроса пользователя.

Родительские элементы
connections (§18.13.2)

Дочерние элементы	Вложенные запросы
dbPr (свойства базы данных)	§18.13.3
extLst (область хранения данных о будущих компонентах)	§18.2.10
olapPr (OLAP Properties)	§18.13.5
параметры (параметры запроса)	§18.13.7
textPr (параметры импорта текста)	§18.13.12
webPr (свойства веб-запроса)	§18.13.13

Атрибуты	Описание
фон (фоновое обновление)	Указывает, можно ли обновить подключение в фоновом режиме (асинхронно). Значение true , если предпочтительное использование подключения — асинхронное обновление в фоновом режиме; Значение false , если предпочтительное использование подключения заключается в синхронном обновлении на переднем плане. Этот флаг следует намеренно игнорировать в определенных случаях. [Пример. Пример того, когда флаг будет игнорироваться, — это подключение к данным OLAP в Microsoft SQL Server Analysis Services, где подключение используется как сводной таблицей, так и функциями CUBE в книге. Это подключение всегда будет синхронно обновляться сводной таблицей и всегда будет обновляться асинхронно функциями CUBE. конец примера Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
учетные данные (метод повторного подключения)	Указывает метод проверки подлинности, используемый при установке (или повторной установке) подключения. Возможные значения для этого атрибута определяются простым типом ST_CredMethod (§18.18.16).
deleted (удаленное подключение)	Указывает, было ли удалено подключение к связанной книге. значение true , если подключение было удалено; в противном случае — значение false. Удаленные подключения содержат только имя атрибутов и deleted=true, все остальные сведения удаляются из файла SpreadsheetML. Если новое соединение создается с тем же именем, что и удаленное соединение, то удаленное подключение перезаписывается новым подключением. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
description (описание подключения)	Указывает описание пользователя для этого подключения. Возможные значения для этого атрибута определяются ST_Xstring простого типа (§22.9.2.19).
id (идентификатор подключения)	Указывает уникальный идентификатор этого подключения. Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.
interval (интервал автоматического обновления)	Указывает количество минут между автоматическим обновлением подключения. Если этот атрибут отсутствует, подключение не обновляется автоматически. Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.
keepAlive (сохранить подключение открытым)	Значение true , если приложение электронной таблицы должно приложить усилия для сохранения подключения открытым. Если задано значение false, приложение должно закрыть подключение после получения сведений. Соответствует свойству MaintainConnection объекта PivotCache. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
minRefreshableVersion (минимальная версия, необходимая для обновления)	Для совместимости с устаревшими приложениями электронной таблицы. Это минимальный номер версии, необходимый для правильного обновления подключения к данным. Этот атрибут применяется к подключениям, которые используются в QueryTable. Возможные значения для этого атрибута определяются типом данных W3C XML Schema unsignedByte .
name (имя подключения)	Указывает имя подключения. Каждое соединение должно иметь уникальное имя. Если подключение помечено как удаленное, а затем добавляется новое подключение с тем же именем, удаленное подключение заменяется новым подключением. Возможные значения для этого атрибута определяются ST_Xstring простого типа (§22.9.2.19).
new (New Connection)	значение true , если подключение не обновлялось в первый раз; в противном случае — значение false. Это состояние может произойти, когда пользователь сохраняет файл до завершения возврата запроса. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
odcFile (файл подключения)	Указывает полный путь к файлу внешнего подключения, из которого было создано это подключение. Если подключение завершается ошибкой при попытке обновить данные и reconnectionMethod=1, приложение электронной таблицы попытается снова использовать сведения из файла внешнего подключения вместо объекта подключения, внедренного в книгу. Это преимущество для управления документами с источниками данных и электронными таблицамиML. Если определение во внешнем файле подключения изменено (например, из-за изменения имени сервера базы данных), книги, которые использовали это подключение, не смогут подключиться со своими внутренними сведениями о подключении и перезагрузить новые сведения о подключении из этого файла. Этот атрибут очищается приложением электронной таблицы, когда пользователь вручную изменяет определение подключения в книге. Может быть выражено в нотации пути файла или для конкретной системы. [Примечание. Приложения могут решать, какие формы поддерживаются и поддерживаются ли системные нотации пути к файлам. конечная заметка] Возможные значения для этого атрибута определяются ST_Xstring простого типа (§22.9.2.19).
OnlyUseConnectionFile (только использовать файл подключения)	Указывает, должно ли приложение электронной таблицы всегда и только использовать сведения о подключении во внешнем файле подключения, указанном атрибутом odcFile при обновлении подключения. Если значение равно false, приложение электронной таблицы должно следовать процедуре, указанной атрибутом reconnectionMethod, описанным ниже. Применяется только к подключениям OLE DB и ODBC, этот атрибут игнорируется для других типов подключений. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
reconnectionMethod (метод reconnection)	Указывает, что должно делать приложение электронной таблицы при сбое подключения. Доступны следующие значения: 1 = при необходимости: при обновлении используйте существующие сведения о подключении. Если существующие сведения не могут использоваться для установления подключения, получите обновленные сведения о подключении, если они доступны из внешнего файла подключения. 2 = Всегда: при каждом обновлении получайте обновленные сведения о подключении из внешнего файла подключения, если они доступны, и используйте их вместо существующих сведений о подключении. В этом случае обновление данных завершится ошибкой, если файл внешнего подключения недоступен. 3 = никогда. Никогда не получайте обновленные сведения о подключении из файла внешнего подключения, даже если они доступны и даже если существующие сведения о подключении не могут быть использованы. Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.
refreshedVersion (версия последнего обновления)	В целях обратной совместимости этот атрибут указывает версию приложения электронной таблицы, которое последнее обновление подключения. Этот атрибут применяется к подключениям, используемым таблицей запросов. Возможные значения для этого атрибута определяются типом данных W3C XML Schema unsignedByte .
refreshOnLoad (обновление при открытии)	Значение true , если это подключение должно быть обновлено при открытии файла; в противном случае — значение false. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
saveData (сохранение данных)	Значение true , если внешние данные, извлекаемые через подключение для заполнения таблицы, должны быть сохранены вместе с книгой; в противном случае — значение false. Это существует в целях безопасности данных. Если внешние данные не сохраняются (или не кэшируются) в книге, учетные данные текущего пользователя могут требоваться каждый раз, когда извлекаются соответствующие данные, и пользователи не увидят данные, которые автор книги использовал в последний раз перед сохранением файла. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
savePassword (сохранить пароль)	Значение true, если пароль должен быть сохранен в составе строка подключения; в противном случае — значение False. Возможные значения этого атрибута определены типом данных boolean схемы XML (консорциум W3C).
singleSignOnId (идентификатор единого входа)	Идентификатор Единый вход (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).
type (тип источника базы данных)	Указывает тип источника данных. Имеются следующие значения: 1. Источник на основе ODBC 2. Источник на основе DAO 3. Источник базы данных на основе файлов 4. Веб-запрос 5. Источник на основе OLE DB 6. Текстовый источник 7. Набор записей 8. DSP Возможные значения для этого атрибута определены в типе данных unsignedInt схемы W3C XML.

[Примечание. Определение xml-схемы W3C для модели содержимого этого элемента (CT_Connection) находится в §A.2. конечная заметка]

ISO/IEC29500: 2008.

Конструкторы

Connection()	Инициализирует новый экземпляр класса Connection.
Connection(IEnumerable<OpenXmlElement>)	Инициализирует новый экземпляр класса Connection с указанными дочерними элементами.
Connection(OpenXmlElement[])	Инициализирует новый экземпляр класса Connection с указанными дочерними элементами.
Connection(String)	Инициализирует новый экземпляр класса Connection из внешнего XML-кода.

Свойства

Background	Фон Представляет следующий атрибут в схеме: background
ChildElements	Возвращает все дочерние узлы текущего элемента. (Унаследовано от OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList. Представляет следующий тег элемента в схеме: x:extLst.
ConnectionFile	odcFile Представляет следующий атрибут в схеме: odcFile
Credentials	Учетные данные Представляет следующий атрибут в схеме: credentials
DatabaseProperties	Свойства базы данных. Представляет следующий тег элемента в схеме: x:dbPr.
Deleted	deleted Представляет следующий атрибут в схеме: deleted
Description	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. Возвращает значение NULL (Nothing в Visual Basic), если такого элемента OpenXmlElement нет. (Унаследовано от 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 Представляет следующий атрибут в схеме: 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)	Возвращает атрибут Open XML с указанным именем тега и URI пространства имен. (Унаследовано от 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. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
NextSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который следует за текущим элементом OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет следующего OpenXmlElement. (Унаследовано от OpenXmlElement)
PrependChild<T>(T)	Вставляет указанный элемент в начало списка дочерних узлов текущего элемента. (Унаследовано от OpenXmlCompositeElement)
PreviousSibling()	Возвращает элемент OpenXmlElement, который непосредственно предшествует текущему элементу OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от OpenXmlElement)
PreviousSibling<T>()	Возвращает элемент OpenXmlElement с указанным типом, который предшествует текущему объекту OpenXmlElement. Возвращает значение NULL (Nothing в Visual Basic), если нет предыдущего элемента OpenXmlElement. (Унаследовано от 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)