Connection Classe

Definição

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Conexão.

Esta classe está disponível no Office 2007 e superior.

Quando o objeto é serializado como xml, o nome qualificado é x:connection.

public class Connection : DocumentFormat.OpenXml.OpenXmlCompositeElement

type Connection = class
    inherit OpenXmlCompositeElement

Public Class Connection
Inherits OpenXmlCompositeElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

Connection

Comentários

[ISO/IEC 29500-1 1st Edition]

ligação (Ligação)

Este elemento contém a definição de como obter numa origem de dados externa, bem como informações que descrevem como a ligação é utilizada no livro. Construções específicas numa folha de cálculo, como fórmulas OLAP, Tabelas de Consulta ou Tabelas Dinâmicas, utilizam informações na ligação para obter ou atualizar dados com base em eventos predefinidos ou no pedido explícito do utilizador.

Elementos pai
ligações (}18.13.2)

Elementos filho	Subclautilizar
dbPr (Propriedades da Base de Dados)	§18.13.3
extLst (Área de Armazenamento de Dados de Funcionalidades Futuras)	§18.2.10
olapPr (Propriedades OLAP)	§18.13.5
parâmetros (Parâmetros de Consulta)	§18.13.7
textPr (Definições de Importação de Texto)	§18.13.12
webPr (Propriedades da Consulta Web)	§18.13.13

Atributos	Descrição
background (Atualização em Segundo Plano)	Indica se a ligação pode ser atualizada em segundo plano (de forma assíncrona). verdadeiro se a utilização preferencial da ligação for atualizar de forma assíncrona em segundo plano; falso se a utilização preferencial da ligação for atualizar de forma síncrona em primeiro plano. Este sinalizador deve ser intencionalmente ignorado em casos específicos. [Exemplo: um exemplo de quando o sinalizador seria ignorado é no caso de uma ligação a dados OLAP no Microsoft SQL Server Analysis Services, em que a ligação é utilizada por uma tabela dinâmica e também por funções DE CUBO no livro. Essa ligação será sempre atualizada de forma síncrona pela Tabela Dinâmica e será sempre atualizada de forma assíncrona pelas funções DE CUBO. exemplo final] Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
credenciais (Método de Restabelecimento de Ligação)	Especifica o método de autenticação a utilizar ao estabelecer (ou restabelecer) a ligação. Os valores possíveis para este atributo são definidos pelo ST_CredMethod tipo simples (}18.18.16).
eliminado (Ligação Eliminada)	Indica se a ligação do livro associada foi eliminada. true se a ligação tiver sido eliminada; caso contrário, falso. As ligações eliminadas contêm apenas o nome dos atributos e deleted=true. Todas as outras informações são removidas do ficheiro SpreadsheetML. Se for criada uma nova ligação com o mesmo nome que uma ligação eliminada, a ligação eliminada será substituída pela nova ligação. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
description (Descrição da Ligação)	Especifica a descrição do utilizador para esta ligação. Os valores possíveis para este atributo são definidos pelo ST_Xstring tipo simples (}22.9.2.19).
ID (ID da Ligação)	Especifica O identificador exclusivo desta ligação. Os valores possíveis para este atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
interval (Intervalo de Atualização Automática)	Especifica o número de minutos entre as atualizações automáticas da ligação. Quando este atributo não está presente, a ligação não é atualizada automaticamente. Os valores possíveis para este atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
keepAlive (Manter a Ligação Aberta)	true quando a aplicação de folha de cálculo deve envidar esforços para manter a ligação aberta. Quando for falsa, a aplicação deve fechar a ligação depois de obter as informações. Isto corresponde à propriedade MaintainConnection de um objeto PivotCache. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
minRefreshableVersion (Versão Mínima Necessária para Atualização)	Para compatibilidade com aplicações de folha de cálculo legadas. Isto representa a versão mínima n.º que é necessária para conseguir atualizar corretamente a ligação de dados. Este atributo aplica-se a ligações que são utilizadas por uma QueryTable. Os valores possíveis para este atributo são definidos pelo tipo de dados Esquema XML W3C unsignedByte .
name (Nome da Ligação)	Especifica o nome da ligação. Cada ligação deve ter um nome exclusivo. Quando uma ligação é marcada como eliminada e, em seguida, é adicionada uma nova ligação com o mesmo nome, a ligação eliminada é substituída pela nova ligação. Os valores possíveis para este atributo são definidos pelo ST_Xstring tipo simples (}22.9.2.19).
novo (Nova Ligação)	true se a ligação não tiver sido atualizada pela primeira vez; caso contrário, falso. Este estado pode ocorrer quando o utilizador guarda o ficheiro antes de terminar a devolução de uma consulta. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
odcFile (Ficheiro de Ligação)	Especifica o caminho completo para o ficheiro de ligação externo a partir do qual esta ligação foi criada. Se uma ligação falhar durante uma tentativa de atualização de dados e restabelecer ligaçãoMethod=1, a aplicação de folha de cálculo tentará novamente com as informações do ficheiro de ligação externo em vez do objeto de ligação incorporado no livro. Esta é uma vantagem para a gestão de documentos de origem de dados e folha de cálculoML. Se a definição no ficheiro de ligação externa for alterada (por exemplo, devido a uma alteração do nome do servidor da base de dados), os livros que utilizaram essa ligação não conseguirão estabelecer ligação com as informações de ligação interna e recarregarão as novas informações de ligação deste ficheiro. Este atributo é limpo pela aplicação de folha de cálculo quando o utilizador edita manualmente a definição de ligação no livro. Pode ser expresso na notação de caminho de ficheiro específico do sistema ou no sistema. [Nota: as aplicações podem decidir que formas suportam e se as notações de caminho de ficheiro específicas do sistema são suportadas. nota de fim] Os valores possíveis para este atributo são definidos pelo ST_Xstring tipo simples (}22.9.2.19).
onlyUseConnectionFile (Utilizar Apenas Ficheiro de Ligação)	Indica se a aplicação de folha de cálculo deve utilizar sempre e apenas as informações de ligação no ficheiro de ligação externo indicado pelo atributo odcFile quando a ligação é atualizada. Se for falso, a aplicação de folha de cálculo deverá seguir o procedimento indicado pelo atributo reconnectionMethod descrito abaixo. Aplica-se apenas às ligações OLE DB e ODBC. Este atributo é ignorado para outros tipos de ligações. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
reconnectionMethod (Método de Restabelecimento de Ligação)	Especifica o que a aplicação de folha de cálculo deve fazer quando uma ligação falha. Os valores são os seguintes: 1 = Conforme necessário: ao atualizar, utilize as informações de ligação existentes. Se não for possível utilizar as informações existentes para estabelecer uma ligação, obtenha informações de ligação atualizadas, se disponíveis no ficheiro de ligação externo. 2 = Sempre: em cada atualização, obtenha informações de ligação atualizadas do ficheiro de ligação externa, se disponível, e utilize-as em vez das informações de ligação existentes. Neste caso, a atualização de dados falhará se o ficheiro de ligação externa não estiver disponível. 3 = Nunca: nunca obtenha informações de ligação atualizadas a partir do ficheiro de ligação externa, mesmo que estejam disponíveis e mesmo que as informações de ligação existentes não possam ser utilizadas. Os valores possíveis para este atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
refreshedVersion (Versão da Última Atualização)	Para efeitos de retrocompatibilidade, este atributo indica a versão da aplicação de folha de cálculo que atualize a ligação pela última vez. Este atributo aplica-se às ligações utilizadas por uma tabela de consulta. Os valores possíveis para este atributo são definidos pelo tipo de dados Esquema XML W3C unsignedByte .
refreshOnLoad (Atualizar ao Abrir)	true se esta ligação deve ser atualizada ao abrir o ficheiro; caso contrário, falso. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
saveData (Guardar Dados)	true se os dados externos obtidos através da ligação para preencher uma tabela forem guardados com o livro; caso contrário, falso. Isto existe para fins de segurança de dados – se não forem guardados dados externos (ou "em cache") no livro, as credenciais de utilizador atuais podem ser sempre necessárias para obter os dados relevantes e as pessoas não verão os dados que o autor do livro utilizou pela última vez antes de guardar o ficheiro. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
savePassword (Guardar Palavra-passe)	true se a palavra-passe for guardada como parte do cadeia de conexão; caso contrário, Falso. Os valores possíveis para este atributo são definidos pelo tipo de dados booleano de esquema XML W3C.
singleSignOnId (ID do SSO)	Identificador para Logon único (SSO) utilizado para autenticação entre um servidor de folha de cálculo intermédioML e a origem de dados externa. [Nota: a conectividade de dados pode utilizar várias tecnologias diferentes. Pode encontrar um exemplo de valores potenciais armazenados neste atributo em: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/spptsdk/html/cSSOReturnCodes_SV01001109.aspnota final] Os valores possíveis para este atributo são definidos pelo ST_Xstring tipo simples (}22.9.2.19).
sourceFile (Ficheiro de Base de Dados de Origem)	Utilizado quando a origem de dados externa é baseada em ficheiros. Quando uma ligação a essa origem de dados falha, a aplicação de folha de cálculo tenta ligar-se diretamente a este ficheiro. Pode ser expresso na notação de caminho de ficheiro específico do sistema ou no sistema. [Nota: as aplicações podem decidir que formas suportam e se as notações de caminho de ficheiro específicas do sistema são suportadas. nota de fim] Os valores possíveis para este atributo são definidos pelo ST_Xstring tipo simples (}22.9.2.19).
type (Tipo de Origem da Base de Dados)	Especifica o tipo de origem de dados. Os valores são: 1. Origem baseada em ODBC 2. Origem baseada em DAO 3. Origem da base de dados baseada em ficheiros 4. Consulta Web 5. Origem baseada em OLE DB 6. Origem baseada em texto 7. conjunto de registos 8. DSP Os valores possíveis para este atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .

[Nota: a definição de Esquema XML W3C do modelo de conteúdo deste elemento (CT_Connection) está localizada em {A.2. nota de fim]

ISO/IEC29500: 2008.

Construtores

Connection()	Inicializa uma nova instância da classe Ligação.
Connection(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Connection com os elementos subordinados especificados.
Connection(OpenXmlElement[])	Inicializa uma nova instância da classe Connection com os elementos subordinados especificados.
Connection(String)	Inicializa uma nova instância da classe Connection a partir de XML externo.

Propriedades

Background	fundo Representa o seguinte atributo no esquema: background
ChildElements	Obtém todos os nós subordinados do elemento atual. (Herdado de OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList. Representa a seguinte etiqueta de elemento no esquema: x:extLst.
ConnectionFile	odcFile Representa o seguinte atributo no esquema: odcFile
Credentials	credenciais Representa o seguinte atributo no esquema: credenciais
DatabaseProperties	DatabaseProperties. Representa a seguinte etiqueta de elemento no esquema: x:dbPr.
Deleted	deleted Representa o seguinte atributo no esquema: eliminado
Description	description Representa o seguinte atributo no esquema: description
ExtendedAttributes	Obtém todos os atributos expandidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Esta coleção de funcionalidades será só de leitura, mas herdará as funcionalidades da parte principal e do pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro elemento subordinado do elemento OpenXmlElement atual. (Herdado de OpenXmlCompositeElement)
HasAttributes	Obtém um valor que indica se o elemento atual tem atributos. (Herdado de OpenXmlElement)
HasChildren	Obtém um valor que indica se o elemento atual tem elementos subordinados. (Herdado de OpenXmlCompositeElement)
Id	id Representa o seguinte atributo no esquema: id
InnerText	Obtém ou define os valores concatenados do nó atual e de todos os respetivos subordinados. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós subordinados do nó atual. (Herdado de OpenXmlCompositeElement)
Interval	interval Representa o seguinte atributo no esquema: intervalo
KeepAlive	keepAlive Representa o seguinte atributo no esquema: keepAlive
LastChild	Obtém o último elemento subordinado do elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir esse elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MCAttributes	Obtém ou define os atributos de compatibilidade de markup. Devolve nulo se não forem definidos atributos de compatibilidade de markup para o elemento atual. (Herdado de OpenXmlElement)
MinRefreshableVersion	minRefreshableVersion Representa o seguinte atributo no esquema: minRefreshableVersion
Name	nome Representa o seguinte atributo no esquema: nome
NamespaceDeclarations	Obtém todas as declarações de espaço de nomes definidas no elemento atual. Devolve um enumerador vazio se não existir nenhuma declaração de espaço de nomes. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
New	Novo Representa o seguinte atributo no esquema: novo
OlapProperties	OlapProperties. Representa a seguinte etiqueta de elemento no esquema: x:olapPr.
OnlyUseConnectionFile	onlyUseConnectionFile Representa o seguinte atributo no esquema: onlyUseConnectionFile
OpenXmlElementContext	Obtém o OpenXmlElementContext do elemento atual. (Herdado de OpenXmlElement)
OuterXml	Obtém a marcação que representa o elemento atual e todos os respetivos elementos subordinados. (Herdado de OpenXmlElement)
Parameters	Parâmetros. Representa a seguinte etiqueta de elemento no esquema: x:parameters.
Parent	Obtém o elemento principal do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo de espaço de nomes do elemento atual. (Herdado de OpenXmlElement)
ReconnectionMethod	reconnectionMethod Representa o seguinte atributo no esquema: reconnectionMethod
RefreshedVersion	refreshedVersion Representa o seguinte atributo no esquema: refreshedVersion
RefreshOnLoad	refreshOnLoad Representa o seguinte atributo no esquema: refreshOnLoad
SaveData	saveData Representa o seguinte atributo no esquema: saveData
SavePassword	savePassword Representa o seguinte atributo no esquema: savePassword
SingleSignOnId	singleSignOnId Representa o seguinte atributo no esquema: singleSignOnId
SourceFile	sourceFile Representa o seguinte atributo no esquema: sourceFile
TextProperties	TextProperties. Representa a seguinte etiqueta de elemento no esquema: x:textPr.
Type	type Representa o seguinte atributo no esquema: tipo
WebQueryProperties	WebQueryProperties. Representa a seguinte etiqueta de elemento no esquema: x:webPr.
XmlQualifiedName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)
XName	Obtém o nome qualificado do elemento atual. (Herdado de OpenXmlElement)

Métodos

AddAnnotation(Object)	Adiciona um objeto à lista de anotações do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
AddChild(OpenXmlElement, Boolean)	Adiciona o elemento especificado ao elemento se for um subordinado conhecido. Esta ação adiciona o elemento na localização correta de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de espaço de nomes ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os predecessores do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os predecessores do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado a partir do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations(Type)	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotations<T>()	Obtém uma coleção de anotações com o tipo especificado para o elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Append(IEnumerable<OpenXmlElement>)	Acrescenta cada elemento de uma lista de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos ao fim da lista de elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao fim da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos expandidos. (Herdado de OpenXmlElement)
Clone()	Cria um duplicado do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria um duplicado deste nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumerar todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os elementos subordinados do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os subordinados do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos do elemento colateral que seguem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos do elemento colateral que precedem o elemento atual e têm o mesmo elemento principal que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da etiqueta especificado e o URI do espaço de nomes. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento subordinado no tipo T. (Herdado de OpenXmlElement)
InsertAfter<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente após o elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertAfterSelf<T>(T)	Insere o elemento especificado imediatamente após o elemento atual. (Herdado de OpenXmlElement)
InsertAt<T>(T, Int32)	Insere o elemento especificado no índice especificado dos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
InsertBefore<T>(T, OpenXmlElement)	Insere o elemento especificado imediatamente antes do elemento de referência especificado. (Herdado de OpenXmlCompositeElement)
InsertBeforeSelf<T>(T)	Insere o elemento especificado imediatamente antes do elemento atual. (Herdado de OpenXmlElement)
IsAfter(OpenXmlElement)	Determina se o elemento atual aparece depois de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual aparece antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
LookupNamespace(String)	Resolve o prefixo do espaço de nomes no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um URI de espaço de nomes no âmbito do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement seguinte. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir um OpenXmlElement seguinte. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Devolve nulo (Nada no Visual Basic) se não existir nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Remove()	Remove o elemento atual do respetivo elemento principal. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos subordinados do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos subordinados do elemento atual que são do tipo T. (Herdado de OpenXmlElement)
RemoveAnnotations(Type)	Remove as anotações do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAnnotations<T>()	Remove as anotações com o tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
RemoveAttribute(String, String)	Remove o atributo do elemento atual. (Herdado de OpenXmlElement)
RemoveChild<T>(T)	Remove o elemento subordinado especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de espaço de nomes para o prefixo especificado. Não remove nada se não existir um prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos subordinados do elemento atual por outro elemento OpenXmlElement. (Herdado de OpenXmlCompositeElement)
SetAttribute(OpenXmlAttribute)	Define um atributo para o elemento especificado. Se o atributo for um atributo conhecido, o valor do atributo é definido. Se o atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define vários atributos para o elemento . Se um atributo for um atributo conhecido, o valor do atributo é definido. Se um atributo for um atributo expandido, o "openxmlAttribute" é adicionado à lista de atributos expandidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Guarda o nó atual no XmlWriter especificado. (Herdado de OpenXmlElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Conexão. Esta classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, o nome qualificado é x:connection. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devolve um enumerador que itera através da coleção subordinada. (Herdado de OpenXmlElement)