Connection Classe

Definição

Namespace:

DocumentFormat.OpenXml.Spreadsheet

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Conexão.

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

Quando o objeto é serializado como xml, seu 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]

conexão (Conexão)

Esse elemento contém a definição de como obter em uma fonte de dados externa, bem como informações que descrevem como a conexão é usada dentro da pasta de trabalho. Construções específicas em uma planilha, como fórmulas OLAP, QueryTables ou Tabelas Dinâmicas, usam informações na conexão para recuperar ou atualizar dados com base em eventos padrão ou na solicitação explícita do usuário.

Elementos pai
conexões (§18.13.2)

Elementos filho	Subclause
dbPr (Propriedades do Banco de Dados)	§18.13.3
extLst (Área de Armazenamento de Dados de Recursos Futuros)	§18.2.10
olapPr (propriedades OLAP)	§18.13.5
parâmetros (Parâmetros de consulta)	§18.13.7
textPr (Configurações de importação de texto)	§18.13.12
WebPr (Propriedades da Consulta Web)	§18.13.13

Atributos	Descrição
plano de fundo (Atualização em segundo plano)	Indica se a conexão pode ser atualizada em segundo plano (de forma assíncrona). true se o uso preferencial da conexão for atualizar assíncronamente em segundo plano; false se o uso preferencial da conexão for atualizar de forma síncrona em primeiro plano. Esse sinalizador deve ser ignorado intencionalmente em casos específicos. [Exemplo: um exemplo de quando o sinalizador seria ignorado é no caso de uma conexão com dados OLAP no Microsoft SQL Server Analysis Services, em que a conexão é usada por uma Tabela Dinâmica e também por funções CUBE na pasta de trabalho. Essa conexão sempre será atualizada de forma síncrona pela Tabela Dinâmica e sempre será atualizada de forma assíncrona pelas funções CUBE. exemplo final] Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
credenciais (Método de Reconexão)	Especifica o método de autenticação a ser usado ao estabelecer (ou restabelecer) a conexão. Os valores possíveis para esse atributo são definidos pelo tipo ST_CredMethod simples (§18.18.16).
excluído (Conexão Excluída)	Indica se a conexão de pasta de trabalho associada foi excluída. true se a conexão tiver sido excluída; caso contrário, false. As conexões excluídas contêm apenas o nome dos atributos e deleted=true, todas as outras informações são removidas do arquivo SpreadsheetML. Se uma nova conexão for criada com o mesmo nome de uma conexão excluída, a conexão excluída será substituída pela nova conexão. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
descrição (Descrição da Conexão)	Especifica a descrição do usuário para essa conexão. Os valores possíveis para esse atributo são definidos pelo tipo ST_Xstring simples (§22.9.2.19).
id (ID de conexão)	Especifica o identificador exclusivo dessa conexão. Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
intervalo (intervalo de atualização automática)	Especifica o número de minutos entre as atualizações automáticas da conexão. Quando esse atributo não está presente, a conexão não é atualizada automaticamente. Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
keepAlive (manter a conexão aberta)	true quando o aplicativo de planilha deve fazer esforços para manter a conexão aberta. Quando falso, o aplicativo deve fechar a conexão depois de recuperar as informações. Isso corresponde à propriedade MaintainConnection de um objeto PivotCache. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
minRefreshableVersion (versão mínima necessária para atualização)	Para compatibilidade com aplicativos de planilha herdados. Isso representa a versão mínima # que é necessária para poder atualizar corretamente a conexão de dados. Esse atributo se aplica a conexões usadas por uma QueryTable. Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedByte .
nome (Nome da conexão)	Especifica o nome da conexão. Cada conexão deve ter um nome exclusivo. Quando uma conexão foi marcada como excluída e, em seguida, uma nova conexão é adicionada com o mesmo nome, a conexão excluída é substituída pela nova conexão. Os valores possíveis para esse atributo são definidos pelo tipo ST_Xstring simples (§22.9.2.19).
new (Nova Conexão)	true se a conexão não tiver sido atualizada pela primeira vez; caso contrário, false. Esse estado pode acontecer quando o usuário salvar o arquivo antes que uma consulta termine de retornar. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
odcFile (arquivo de conexão)	Especifica o caminho completo para o arquivo de conexão externa do qual essa conexão foi criada. Se uma conexão falhar durante uma tentativa de atualizar dados e reconectarMethod=1, o aplicativo de planilha tentará novamente usar informações do arquivo de conexão externa em vez do objeto de conexão inserido na pasta de trabalho. Esse é um benefício para a origem de dados e a capacidade de gerenciamento de documentos spreadsheetML. Se a definição no arquivo de conexão externa for alterada (por exemplo, devido a uma alteração de nome do servidor de banco de dados), as pastas de trabalho que fizeram uso dessa conexão falharão em se conectar com suas informações de conexão interna e recarregarão as novas informações de conexão desse arquivo. Esse atributo é desmarcado pelo aplicativo de planilha quando o usuário edita manualmente a definição de conexão na pasta de trabalho. Pode ser expressa na notação de caminho de arquivo ou específica do sistema. [Observação: os aplicativos podem decidir quais formas dão suporte e se há suporte para notações de caminho de arquivo específicas do sistema. nota final] Os valores possíveis para esse atributo são definidos pelo tipo ST_Xstring simples (§22.9.2.19).
onlyUseConnectionFile (usar somente o arquivo de conexão)	Indica se o aplicativo de planilha deve sempre e usar apenas as informações de conexão no arquivo de conexão externo indicado pelo atributo odcFile quando a conexão for atualizada. Se for falso, o aplicativo de planilha deverá seguir o procedimento indicado pelo atributo reconnectionMethod descrito abaixo. Aplica-se apenas às conexões OLE DB e ODBC, esse atributo é ignorado para outros tipos de conexões. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
reconnectionMethod (Método De Reconexão)	Especifica o que o aplicativo de planilha deve fazer quando uma conexão falha. Os valores são os seguintes: 1 = Conforme necessário: na atualização, use as informações de conexão existentes. Se as informações existentes não puderem ser usadas para estabelecer uma conexão, obtenha informações de conexão atualizadas, se estiverem disponíveis no arquivo de conexão externa. 2 = Always: em cada atualização, obtenha informações de conexão atualizadas do arquivo de conexão externa, se estiver disponível, e use-as em vez das informações de conexão existentes. Nesse caso, a atualização de dados falhará se o arquivo de conexão externa não estiver disponível. 3 = Nunca: nunca obtenha informações de conexão atualizadas do arquivo de conexão externa, mesmo que estejam disponíveis e mesmo que as informações de conexão existentes não possam ser usadas. Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .
refreshedVersion (última versão de atualização)	Para fins de compatibilidade com versões anteriores, esse atributo indica a versão do aplicativo de planilha que atualizou a conexão pela última vez. Esse atributo se aplica a conexões usadas por uma tabela de consulta. Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedByte .
refreshOnLoad (Atualização em Aberto)	true se essa conexão deve ser atualizada ao abrir o arquivo; caso contrário, false. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
saveData (Salvar Dados)	true se os dados externos buscados sobre a conexão para preencher uma tabela forem salvos com a pasta de trabalho; caso contrário, false. Isso existe para fins de segurança de dados - se nenhum dado externo for salvo em (ou "armazenado em cache") na pasta de trabalho, as credenciais atuais do usuário poderão ser necessárias sempre para recuperar os dados relevantes e as pessoas não verão os dados que o autor da pasta de trabalho estava usando pela última vez antes de salvar o arquivo. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
savePassword (Salvar Senha)	true se a senha for salva como parte do cadeia de conexão; caso contrário, False. Os valores possíveis para esse atributo são definidos pelo tipo de dados booliano W3C XML Schema.
singleSignOnId (Id do SSO)	Identificador para SSO (Logon único) usado para autenticação entre um servidor de planilha intermediária e a fonte de dados externa. [Observação: a conectividade de dados pode usar várias tecnologias diferentes. Um exemplo de valores potenciais armazenados neste atributo pode ser encontrado em: http://msdn.microsoft.com/library/default.asp?url=/library/en-us/spptsdk/html/cSSOReturnCodes_SV01001109.aspobservação final] Os valores possíveis para esse atributo são definidos pelo tipo ST_Xstring simples (§22.9.2.19).
sourceFile (arquivo de banco de dados de origem)	Usado quando a fonte de dados externa é baseada em arquivo. Quando uma conexão com essa fonte de dados falha, o aplicativo de planilha tenta se conectar diretamente a esse arquivo. Pode ser expressa na notação de caminho de arquivo ou específica do sistema. [Observação: os aplicativos podem decidir quais formas dão suporte e se há suporte para notações de caminho de arquivo específicas do sistema. nota final] Os valores possíveis para esse atributo são definidos pelo tipo ST_Xstring simples (§22.9.2.19).
tipo (Tipo de Origem do Banco de Dados)	Especifica o tipo de fonte de dados. Os valores são: 1. Fonte baseada em ODBC 2. Fonte baseada em DAO 3. Fonte de banco de dados baseada em arquivo 4. Consulta web 5. Fonte baseada em OLE DB 6. Fonte baseada em texto 7. conjunto de registros 8. DSP Os valores possíveis para esse atributo são definidos pelo tipo de dados W3C XML Schema unsignedInt .

[Observação: a definição de Esquema XML W3C do modelo de conteúdo desse elemento (CT_Connection) está localizada em §A.2. nota final]

ISO/IEC29500: 2008.

Construtores

Connection()	Inicializa uma nova instância da classe Connection.
Connection(IEnumerable<OpenXmlElement>)	Inicializa uma nova instância da classe Connection com os elementos filho especificados.
Connection(OpenXmlElement[])	Inicializa uma nova instância da classe Connection com os elementos filho especificados.
Connection(String)	Inicializa uma nova instância da classe Connection do XML externo.

Propriedades

Background	Fundo Representa o seguinte atributo no esquema: plano de fundo
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
ConnectionExtensionList	ConnectionExtensionList. Representa a seguinte marca 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 marca de elemento no esquema: x:dbPr.
Deleted	deleted Representa o seguinte atributo no esquema: excluído
Description	description Representa o seguinte atributo no esquema: descrição
ExtendedAttributes	Obtém todos os atributos estendidos (atributos não definidos no esquema) do elemento atual. (Herdado de OpenXmlElement)
Features	Obtém um IFeatureCollection para o elemento atual. Essa coleção de recursos será somente leitura, mas herdará recursos de sua parte pai e pacote, se disponível. (Herdado de OpenXmlElement)
FirstChild	Obtém o primeiro filho 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 filho. (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 seus filhos. (Herdado de OpenXmlCompositeElement)
InnerXml	Obtém ou define a marcação que representa apenas os nós filho 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 filho do elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver 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 marcação. Retorna nulo se nenhum atributo de compatibilidade de marcação for definido 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 namespace definidas no elemento atual. Retornará um enumerador vazio se não houver nenhuma declaração de namespace. (Herdado de OpenXmlElement)
NamespaceUri	Obtém o URI do namespace do elemento atual. (Herdado de OpenXmlElement)
New	Novo Representa o seguinte atributo no esquema: novo
OlapProperties	OlapProperties. Representa a seguinte marca 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 seus elementos filho. (Herdado de OpenXmlElement)
Parameters	Parâmetros. Representa a seguinte marca de elemento no esquema: x:parâmetros.
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo namespace 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 marca de elemento no esquema: x:textPr.
Type	type Representa o seguinte atributo no esquema: tipo
WebQueryProperties	WebQueryProperties. Representa a seguinte marca 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 ele for uma criança conhecida. Isso adiciona o elemento no local correto de acordo com o esquema. (Herdado de OpenXmlCompositeElement)
AddNamespaceDeclaration(String, String)	Adiciona uma declaração de namespace ao nó atual. (Herdado de OpenXmlElement)
Ancestors()	Enumera todos os ancestrais do elemento atual. (Herdado de OpenXmlElement)
Ancestors<T>()	Enumera apenas os ancestrais do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
Annotation(Type)	Obtenha o primeiro objeto de anotação do tipo especificado do elemento OpenXmlElement atual. (Herdado de OpenXmlElement)
Annotation<T>()	Obtenha o primeiro objeto de anotação do tipo especificado 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 final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
Append(OpenXmlElement[])	Acrescenta cada elemento de uma matriz de elementos até o final da lista de elementos filho do elemento atual. (Herdado de OpenXmlElement)
AppendChild<T>(T)	Acrescenta o elemento especificado ao final da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
ClearAllAttributes()	Limpa todos os atributos, incluindo atributos conhecidos e atributos estendidos. (Herdado de OpenXmlElement)
Clone()	Cria uma duplicata do nó atual. (Herdado de OpenXmlElement)
CloneNode(Boolean)	Cria uma duplicata desse nó.
Descendants()	Enumera todos os descendentes do elemento atual. (Herdado de OpenXmlElement)
Descendants<T>()	Enumera todos os descendentes do elemento atual do tipo T. (Herdado de OpenXmlElement)
Elements()	Enumera todos os filhos do elemento atual. (Herdado de OpenXmlElement)
Elements<T>()	Enumera apenas os filhos do elemento atual que têm o tipo especificado. (Herdado de OpenXmlElement)
ElementsAfter()	Enumera todos os elementos irmãos que seguem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
ElementsBefore()	Enumera todos os elementos irmãos que precedem o elemento atual e têm o mesmo pai que o elemento atual. (Herdado de OpenXmlElement)
GetAttribute(String, String)	Obtém um atributo Open XML com o nome da marca e o URI do namespace especificados. (Herdado de OpenXmlElement)
GetAttributes()	Obtém uma lista que contém uma cópia de todos os atributos. (Herdado de OpenXmlElement)
GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)
GetFirstChild<T>()	Localiza o primeiro elemento filho 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 filhos 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 é exibido após um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
IsBefore(OpenXmlElement)	Determina se o elemento atual é exibido antes de um elemento especificado na ordem do documento. (Herdado de OpenXmlElement)
LookupNamespace(String)	Resolve o prefixo namespace no contexto do nó atual. (Herdado de OpenXmlElement)
LookupPrefix(String)	Localiza o prefixo correspondente para um uri de namespace no escopo do elemento atual. (Herdado de OpenXmlElement)
NextSibling()	Obtém o elemento OpenXmlElement que segue imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum próximo elemento OpenXmlElement. (Herdado de OpenXmlElement)
NextSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que segue o elemento OpenXmlElement atual. Retornará nulo (Nada no Visual Basic) se não houver o próximo OpenXmlElement. (Herdado de OpenXmlElement)
PrependChild<T>(T)	Insere o elemento especificado no início da lista de nós filho do elemento atual. (Herdado de OpenXmlCompositeElement)
PreviousSibling()	Obtém o elemento OpenXmlElement que precede imediatamente o elemento OpenXmlElement atual. Retorna nulo (Nada no Visual Basic ) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
PreviousSibling<T>()	Obtém o elemento OpenXmlElement com o tipo especificado que precede o OpenXmlElement atual. Retorna nulo (Nada no Visual Basic) se não houver nenhum elemento OpenXmlElement anterior. (Herdado de OpenXmlElement)
Remove()	Remove o elemento atual de seu pai. (Herdado de OpenXmlElement)
RemoveAllChildren()	Remove todos os elementos filho do elemento atual. (Herdado de OpenXmlCompositeElement)
RemoveAllChildren<T>()	Remova todos os elementos filho 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 filho especificado. (Herdado de OpenXmlCompositeElement)
RemoveNamespaceDeclaration(String)	Remove a declaração de namespace do prefixo especificado. Não removerá nada se não houver nenhum prefixo. (Herdado de OpenXmlElement)
ReplaceChild<T>(OpenXmlElement, T)	Substitui um dos elementos filho 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 será definido. Se o atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
SetAttributes(IEnumerable<OpenXmlAttribute>)	Define uma série de atributos para o elemento. Se um atributo for um atributo conhecido, o valor do atributo será definido. Se um atributo for um atributo estendido, o 'openxmlAttribute' será adicionado à lista de atributos estendidos. (Herdado de OpenXmlElement)
WriteTo(XmlWriter)	Salva o nó atual no XmlWriter especificado. (Herdado de OpenXmlElement)

Implantações explícitas de interface

IEnumerable.GetEnumerator()	Conexão. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é x:connection. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)