Connection Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Spreadsheet

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Connection.

Esta clase está disponible en Office 2007 y versiones posteriores.

Cuando el objeto se serializa como xml, su nombre completo es x:connection.

public class Connection : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Connection = class
    inherit OpenXmlCompositeElement

Public Class Connection
Inherits OpenXmlCompositeElement

Herencia

Object

OpenXmlElement

OpenXmlCompositeElement

Connection

Comentarios

[ISO/IEC 29500-1 1.ª edición]

connection (Connection)

Este elemento contiene tanto la definición de cómo obtener acceso a un origen de datos externo como información que describe cómo se usa la conexión en el libro. Las construcciones específicas de una hoja de cálculo, como fórmulas OLAP, querytables o tablas dinámicas, usan la información de la conexión para recuperar o actualizar datos basados en eventos predeterminados o en la solicitud explícita del usuario.

Elementos primarios
conexiones (§18.13.2)

Elementos secundarios	Subclause
dbPr (propiedades de base de datos)	§18.13.3
extLst (Área de almacenamiento de datos de características futuras)	§18.2.10
olapPr (propiedades OLAP)	§18.13.5
parámetros (parámetros de consulta)	§18.13.7
textPr (Configuración de importación de texto)	§18.13.12
webPr (propiedades de consulta web)	§18.13.13

Atributos	Descripción
fondo (actualización en segundo plano)	Indica si la conexión se puede actualizar en segundo plano (de forma asincrónica). true si el uso preferido de la conexión es actualizar de forma asincrónica en segundo plano; false si el uso preferido de la conexión es actualizar sincrónicamente en primer plano. Esta marca debe omitirse intencionadamente en casos específicos. [Ejemplo: un ejemplo de cuándo se omitiría la marca es en el caso de una conexión a datos OLAP en Microsoft SQL Server Analysis Services, donde la conexión la usa una tabla dinámica y también las funciones CUBE dentro del libro. La tabla dinámica siempre actualizará esa conexión de forma sincrónica y las funciones CUBE siempre las actualizarán de forma asincrónica. Fin del ejemplo] El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
credentials (método Reconnection)	Especifica el método de autenticación que se va a usar al establecer (o volver a establecer) la conexión. Los valores posibles para este atributo se definen mediante el ST_CredMethod tipo simple (§18.18.16).
deleted (Conexión eliminada)	Indica si se ha eliminado la conexión de libro asociada. true si se ha eliminado la conexión; De lo contrario, false. Las conexiones eliminadas solo contienen el nombre de atributos y deleted=true, toda la información restante se quita del archivo SpreadsheetML. Si se crea una nueva conexión con el mismo nombre que una conexión eliminada, la nueva conexión sobrescribe la conexión eliminada. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
description (Connection Description)	Especifica la descripción del usuario para esta conexión. Los valores posibles para este atributo se definen mediante el ST_Xstring tipo simple (§22.9.2.19).
id (Id. de conexión)	Especifica el identificador único de esta conexión. Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.
interval (Intervalo de actualización automática)	Especifica el número de minutos entre las actualizaciones automáticas de la conexión. Cuando este atributo no está presente, la conexión no se actualiza automáticamente. Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.
keepAlive (Mantener la conexión abierta)	true cuando la aplicación de hoja de cálculo debe realizar esfuerzos para mantener abierta la conexión. Cuando es false, la aplicación debe cerrar la conexión después de recuperar la información. Esto corresponde a la propiedad MaintainConnection de un objeto PivotCache. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
minRefreshableVersion (versión mínima necesaria para la actualización)	Para la compatibilidad con aplicaciones de hoja de cálculo heredadas. Esto representa la versión mínima # necesaria para poder actualizar correctamente la conexión de datos. Este atributo se aplica a las conexiones que usa una queryTable. Los valores posibles para este atributo se definen mediante el tipo de datos W3C XML Schema unsignedByte .
name (Nombre de conexión)	Especifica el nombre de la conexión. Cada conexión debe tener un nombre único. Cuando una conexión se ha marcado como eliminada y, a continuación, se agrega una nueva conexión con el mismo nombre, la conexión eliminada se reemplaza por la nueva conexión. Los valores posibles para este atributo se definen mediante el ST_Xstring tipo simple (§22.9.2.19).
new (Nueva conexión)	true si la conexión no se ha actualizado por primera vez; De lo contrario, false. Este estado puede producirse cuando el usuario guarda el archivo antes de que una consulta haya terminado de devolverse. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
odcFile (archivo de conexión)	Especifica la ruta de acceso completa al archivo de conexión externo desde el que se creó esta conexión. Si se produce un error en una conexión durante un intento de actualizar los datos y reconnectionMethod=1, la aplicación de hoja de cálculo volverá a intentarlo con información del archivo de conexión externo en lugar del objeto de conexión incrustado en el libro. Se trata de una ventaja para la administración de documentos spreadsheetML y origen de datos. Si se cambia la definición en el archivo de conexión externa (por ejemplo, debido a un cambio en el nombre del servidor de base de datos), los libros que usaron esa conexión no se conectarán con su información de conexión interna y volverán a cargar la nueva información de conexión de este archivo. La aplicación de hoja de cálculo borra este atributo cuando el usuario edita manualmente la definición de conexión dentro del libro. Se puede expresar en o notación de ruta de acceso de archivo específica del sistema. [Nota: Las aplicaciones pueden decidir qué formas de admiten y si se admiten las notaciones de ruta de acceso de archivo específicas del sistema. Fin de la nota] Los valores posibles para este atributo se definen mediante el ST_Xstring tipo simple (§22.9.2.19).
onlyUseConnectionFile (usar solo el archivo de conexión)	Indica si la aplicación de hoja de cálculo debe usar siempre y solo la información de conexión en el archivo de conexión externo indicado por el atributo odcFile cuando se actualiza la conexión. Si es false, la aplicación de hoja de cálculo debe seguir el procedimiento indicado por el atributo reconnectionMethod que se describe a continuación. Solo se aplica a las conexiones OLE DB y ODBC, este atributo se omite para otros tipos de conexiones. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
reconnectionMethod (método Reconnection)	Especifica lo que debe hacer la aplicación de hoja de cálculo cuando se produce un error en una conexión. Los valores son los siguientes: 1 = Según sea necesario: en la actualización, use la información de conexión existente. Si la información existente no se puede usar para establecer una conexión, obtenga información de conexión actualizada, si está disponible en el archivo de conexión externo. 2 = Siempre: en cada actualización, obtenga información de conexión actualizada del archivo de conexión externo, si está disponible, y úsela en lugar de la información de conexión existente. En este caso, se producirá un error en la actualización de datos si el archivo de conexión externo no está disponible. 3 = Nunca: Nunca obtenga información de conexión actualizada del archivo de conexión externo aunque esté disponible e incluso si no se puede usar la información de conexión existente. Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.
refreshedVersion (última versión de actualización)	Por motivos de compatibilidad con versiones anteriores, este atributo indica la versión de la aplicación de hoja de cálculo que actualró por última vez la conexión. Este atributo se aplica a las conexiones que usa una tabla de consulta. Los valores posibles para este atributo se definen mediante el tipo de datos W3C XML Schema unsignedByte .
refreshOnLoad (Actualizar al abrir)	true si se debe actualizar esta conexión al abrir el archivo; De lo contrario, false. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
saveData (Guardar datos)	true si los datos externos capturados a través de la conexión para rellenar una tabla se guardarán con el libro; De lo contrario, false. Esto existe con fines de seguridad de datos: si no se guarda ningún dato externo en (o se "almacena en caché") en el libro, se pueden requerir credenciales de usuario actuales cada vez para recuperar los datos pertinentes y las personas no verán los datos que el autor del libro había estado usando por última vez antes de guardar el archivo. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
savePassword (Guardar contraseña)	true si la contraseña se va a guardar como parte del cadena de conexión; en caso contrario, False. El tipo de datos boolean del esquema XML W3C define los valores posibles para este atributo.
singleSignOnId (id. de SSO)	Identificador de Inicio de sesión único (SSO) que se usa para la autenticación entre un servidor spreadsheetML intermedio y el origen de datos externo. [Nota: La conectividad de datos puede usar varias tecnologías diferentes. Puede encontrar un ejemplo de valores potenciales almacenados en este atributo en: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/spptsdk/html/cSSOReturnCodes_SV01001109.aspnota final] Los valores posibles para este atributo se definen mediante el ST_Xstring tipo simple (§22.9.2.19).
sourceFile (archivo de base de datos de origen)	Se usa cuando el origen de datos externo se basa en archivos. Cuando se produce un error en una conexión a este origen de datos, la aplicación de hoja de cálculo intenta conectarse directamente a este archivo. Se puede expresar en o notación de ruta de acceso de archivo específica del sistema. [Nota: Las aplicaciones pueden decidir qué formas de admiten y si se admiten las notaciones de ruta de acceso de archivo específicas del sistema. Fin de la nota] Los valores posibles para este atributo se definen mediante el ST_Xstring tipo simple (§22.9.2.19).
type (Tipo de origen de base de datos)	Especifica el tipo de origen de datos. Los valores son los siguientes: 1. Origen basado en ODBC 2. Origen basado en DAO 3. Origen de base de datos basada en archivos 4. Consulta web 5. Origen basado en OLE DB 6. Origen basado en texto 7. conjunto de registros 8. DSP Los valores posibles para este atributo los define el tipo de datos unsignedInt del esquema XML W3C.

[Nota: La definición del esquema XML W3C del modelo de contenido de este elemento (CT_Connection) se encuentra en §A.2. Fin de la nota]

ISO/IEC29500: 2008.

Constructores

Connection()	Inicializa una nueva instancia de la clase Connection.
Connection(IEnumerable<OpenXmlElement>)	Inicializa una nueva instancia de la clase Connection con los elementos secundarios especificados.
Connection(OpenXmlElement[])	Inicializa una nueva instancia de la clase Connection con los elementos secundarios especificados.
Connection(String)	Inicializa una nueva instancia de la clase Connection a partir de XML externo.

Propiedades

Background	Fondo Representa el atributo siguiente en el esquema: fondo
ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList. Representa la siguiente etiqueta de elemento en el esquema: x:extLst.
ConnectionFile	odcFile Representa el atributo siguiente en el esquema: odcFile
Credentials	Credenciales Representa el atributo siguiente en el esquema: credenciales
DatabaseProperties	DatabaseProperties. Representa la siguiente etiqueta de elemento en el esquema: x:dbPr.
Deleted	deleted Representa el atributo siguiente en el esquema: deleted
Description	description Representa el atributo siguiente en el esquema: description
ExtendedAttributes	Obtiene todos los atributos extendidos (atributos no definidos en el esquema) del elemento actual. (Heredado de OpenXmlElement)
Features	Obtiene un IFeatureCollection para el elemento actual. Esta colección de características será de solo lectura, pero heredará características de su elemento primario y paquete si está disponible. (Heredado de OpenXmlElement)
FirstChild	Obtiene el primer elemento secundario del elemento OpenXmlElement actual. (Heredado de OpenXmlCompositeElement)
HasAttributes	Obtiene un valor que indica si el elemento actual tiene atributos. (Heredado de OpenXmlElement)
HasChildren	Obtiene un valor que indica si el elemento actual tiene algún elemento secundario. (Heredado de OpenXmlCompositeElement)
Id	id Representa el atributo siguiente en el esquema: id.
InnerText	Obtiene o establece los valores concatenados del nodo actual y todos sus elementos secundarios. (Heredado de OpenXmlCompositeElement)
InnerXml	Obtiene o establece el marcado que representa solo los nodos secundarios del nodo actual. (Heredado de OpenXmlCompositeElement)
Interval	interval Representa el atributo siguiente en el esquema: interval
KeepAlive	keepAlive Representa el atributo siguiente en el esquema: keepAlive
LastChild	Obtiene el último elemento secundario del elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement de este tipo. (Heredado de OpenXmlCompositeElement)
LocalName	Obtiene el nombre local del elemento actual. (Heredado de OpenXmlElement)
MCAttributes	Obtiene o establece los atributos de compatibilidad de marcado. Devuelve null si no se definen atributos de compatibilidad de marcado para el elemento actual. (Heredado de OpenXmlElement)
MinRefreshableVersion	minRefreshableVersion Representa el atributo siguiente en el esquema: minRefreshableVersion
Name	name Representa el atributo siguiente en el esquema: name
NamespaceDeclarations	Obtiene todas las declaraciones de espacio de nombres definidas en el elemento actual. Devuelve un enumerador vacío si no hay ninguna declaración de espacio de nombres. (Heredado de OpenXmlElement)
NamespaceUri	Obtiene el URI del espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
New	Nuevo Representa el atributo siguiente en el esquema: new
OlapProperties	OlapProperties. Representa la siguiente etiqueta de elemento en el esquema: x:olapPr.
OnlyUseConnectionFile	onlyUseConnectionFile Representa el atributo siguiente en el esquema: onlyUseConnectionFile
OpenXmlElementContext	Obtiene el Objeto OpenXmlElementContext del elemento actual. (Heredado de OpenXmlElement)
OuterXml	Obtiene el marcado que representa el elemento actual y todos sus elementos secundarios. (Heredado de OpenXmlElement)
Parameters	Parámetros. Representa la siguiente etiqueta de elemento en el esquema: x:parameters.
Parent	Obtiene el elemento primario del elemento actual. (Heredado de OpenXmlElement)
Prefix	Obtiene el prefijo de espacio de nombres del elemento actual. (Heredado de OpenXmlElement)
ReconnectionMethod	reconnectionMethod Representa el atributo siguiente en el esquema: reconnectionMethod
RefreshedVersion	refreshedVersion Representa el atributo siguiente en el esquema: refreshedVersion
RefreshOnLoad	refreshOnLoad Representa el atributo siguiente en el esquema: refreshOnLoad
SaveData	Savedata Representa el atributo siguiente en el esquema: saveData
SavePassword	savePassword Representa el atributo siguiente en el esquema: savePassword
SingleSignOnId	singleSignOnId Representa el atributo siguiente en el esquema: singleSignOnId
SourceFile	sourceFile Representa el atributo siguiente en el esquema: sourceFile
TextProperties	TextProperties. Representa la siguiente etiqueta de elemento en el esquema: x:textPr.
Type	type Representa el atributo siguiente en el esquema: type
WebQueryProperties	WebQueryProperties. Representa la siguiente etiqueta de elemento en el esquema: x:webPr.
XmlQualifiedName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)
XName	Obtiene el nombre completo del elemento actual. (Heredado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Agrega un objeto a la lista de anotaciones del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Agrega el elemento especificado al elemento si es un elemento secundario conocido. Esto agrega el elemento en la ubicación correcta según el esquema. (Heredado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Agrega una declaración de espacio de nombres al nodo actual. (Heredado de OpenXmlElement)
Ancestors()	Enumera todos los antecesores del elemento actual. (Heredado de OpenXmlElement)
Ancestors<T>()	Enumera solo los antecesores del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
Annotation(Type)	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotation<T>()	Obtenga el primer objeto de anotación del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations(Type)	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Annotations<T>()	Obtiene una colección de anotaciones con el tipo especificado para el elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Anexa cada elemento de una lista de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Append(OpenXmlElement[])	Anexa cada elemento de una matriz de elementos al final de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
AppendChild<T>(T)	Anexa el elemento especificado al final de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
ClearAllAttributes()	Borra todos los atributos, incluidos los atributos conocidos y los atributos extendidos. (Heredado de OpenXmlElement)
Clone()	Crea un duplicado del nodo actual. (Heredado de OpenXmlElement)
CloneNode(Boolean)	Crea un duplicado de este nodo.
Descendants()	Enumera todos los descendientes del elemento actual. (Heredado de OpenXmlElement)
Descendants<T>()	Enumera todos los descendientes del elemento actual del tipo T. (Heredado de OpenXmlElement)
Elements()	Enumera todos los elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
Elements<T>()	Enumera solo los elementos secundarios del elemento actual que tienen el tipo especificado. (Heredado de OpenXmlElement)
ElementsAfter()	Enumera todos los elementos del mismo nivel que siguen el elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
ElementsBefore()	Enumera todos los elementos del mismo nivel que preceden al elemento actual y tienen el mismo elemento primario que el elemento actual. (Heredado de OpenXmlElement)
GetAttribute(String, String)	Obtiene un atributo Open XML con el nombre de etiqueta y el URI de espacio de nombres especificados. (Heredado de OpenXmlElement)
GetAttributes()	Obtiene una lista que contiene una copia de todos los atributos. (Heredado de OpenXmlElement)
GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)
GetFirstChild<T>()	Busca el primer elemento secundario en el tipo T. (Heredado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente después del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Inserta el elemento especificado inmediatamente después del elemento actual. (Heredado de OpenXmlElement)
InsertAt<T>(T, Int32)	Inserta el elemento especificado en el índice especificado de los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente antes del elemento de referencia especificado. (Heredado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Inserta el elemento especificado inmediatamente antes del elemento actual. (Heredado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina si el elemento actual aparece después de un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina si el elemento actual aparece antes que un elemento especificado en el orden del documento. (Heredado de OpenXmlElement)
LookupNamespace(String)	Resuelve el prefijo de espacio de nombres en el contexto del nodo actual. (Heredado de OpenXmlElement)
LookupPrefix(String)	Busca el prefijo correspondiente para un uri de espacio de nombres en el ámbito del elemento actual. (Heredado de OpenXmlElement)
NextSibling()	Obtiene el elemento OpenXmlElement que sigue inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
NextSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que sigue al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement siguiente. (Heredado de OpenXmlElement)
PrependChild<T>(T)	Inserta el elemento especificado al principio de la lista de nodos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
PreviousSibling()	Obtiene el elemento OpenXmlElement que precede inmediatamente al elemento OpenXmlElement actual. Devuelve null (Nothing en Visual Basic ) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
PreviousSibling<T>()	Obtiene el elemento OpenXmlElement con el tipo especificado que precede al objeto OpenXmlElement actual. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement anterior. (Heredado de OpenXmlElement)
Remove()	Quita el elemento actual de su elemento primario. (Heredado de OpenXmlElement)
RemoveAllChildren()	Quita todos los elementos secundarios del elemento actual. (Heredado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Quite todos los elementos secundarios del elemento actual que son de tipo T. (Heredado de OpenXmlElement)
RemoveAnnotations(Type)	Quita las anotaciones del tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAnnotations<T>()	Quita las anotaciones con el tipo especificado del elemento OpenXmlElement actual. (Heredado de OpenXmlElement)
RemoveAttribute(String, String)	Quita el atributo del elemento actual. (Heredado de OpenXmlElement)
RemoveChild<T>(T)	Quita el elemento secundario especificado. (Heredado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Quita la declaración de espacio de nombres para el prefijo especificado. No quita nada si no hay ningún prefijo. (Heredado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Reemplaza uno de los elementos secundarios del elemento actual por otro elemento OpenXmlElement. (Heredado de OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Establece un atributo en el elemento especificado. Si el atributo es un atributo conocido, se establece el valor del atributo. Si el atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Establece una serie de atributos en el elemento . Si un atributo es un atributo conocido, se establece el valor del atributo. Si un atributo es un atributo extendido, el atributo "openxmlAttribute" se agrega a la lista de atributos extendidos. (Heredado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda el nodo actual en el objeto XmlWriter especificado. (Heredado de OpenXmlElement)

Implementaciones de interfaz explícitas

IEnumerable.GetEnumerator()	Connection. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es x:connection. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)