MailMerge Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Configurações de mesclagem de email.

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

Quando o objeto é serializado como xml, seu nome qualificado é w:mailMerge.

public class MailMerge : DocumentFormat.OpenXml.OpenXmlCompositeElement

type MailMerge = class
    inherit OpenXmlCompositeElement

Public Class MailMerge
Inherits OpenXmlCompositeElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

MailMerge

Comentários

[ISO/IEC 29500-1 1st Edition]

mailMerge (Configurações de mesclagem de email)

Esse elemento especifica todas as informações de mesclagem de email para um documento que foi conectado a uma fonte de dados externa como parte de uma operação de mesclagem de email.

O documento que contém esses dados de mesclagem de email pode ser de um dos dois tipos:

• Um documento de origem, o documento que contém todas as informações para a mesclagem de email e é usado em conjunto com um aplicativo para se conectar a uma fonte de dados externa e criar um documento para cada registro nessa fonte de dados.

• Um documento mesclado, um documento que contém todas as informações para a mesclagem de email, bem como uma referência a um único registro específico que deve ser usado para preencher os valores de todos os campos de mesclagem nesse documento.

As informações neste elemento devem conter todos os dados necessários para se conectar a uma fonte de dados e preencher todos os campos de mesclagem no documento com dados dessa fonte de dados.

[Exemplo: considere o seguinte fragmento wordprocessingML para um documento que faz parte de uma mesclagem de email:

<w:mailMerge>  
  …  <w:dataType w:val="spreadsheet" />  
  <w:query w:val="SELECT * FROM `Sheet1$`" />  
  <w:dataSource r:id="rId1" />  
  …</w:mailMerge>  

Aqui, os elementos dataType (§17.14.10) e dataSource (§17.14.9) especificam que o documento fornecido deve ser conectado à fonte de dados externa referenciada pela relação cujo valor de ID é igual a rId1. Embora conectado à fonte de dados externa, o documento junto com um aplicativo de hospedagem pode extrair dados da fonte de dados externa, conforme especificado pelo elemento thequery (§17.14.26). exemplo final]

Elementos pai
configurações (§17.15.1.78)

Elementos filho	Subclause
activeRecord (registro exibido atualmente no documento mesclado)	§17.14.2
addressFieldName (coluna que contém endereço de email)	§17.14.3
checkErrors (Configuração de relatório de erro de mesclagem de email)	§17.14.4
connectString (Cadeia de conexão de fonte de dados)	§17.14.8
dataSource (Caminho do Arquivo de Fonte de Dados)	§17.14.9
dataType (Tipo de Fonte de Dados)	§17.14.10
destino (Destino de documento mesclado)	§17.14.11
doNotSuppressBlankLines (remover linhas em branco de documentos mesclados)	§17.14.12
headerSource (caminho do arquivo de definição de cabeçalho)	§17.14.16
linkToQuery (Consulta contém link para arquivo de consulta externa)	§17.14.18
mailAsAttachment (documento mesclado ao anexo de email)	§17.14.19
mailSubject (E-mail mesclado ou Linha de Assunto de Fax)	§17.14.21
mainDocumentType (tipo de documento de origem)	§17.14.22
odso (Configurações de objeto da fonte de dados do Office)	§17.14.25
consulta (Consulta para a mesclagem de registros de fonte de dados)	§17.14.26
viewMergedData (exibir dados mesclados no documento)	§17.14.36

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

ISO/IEC29500: 2008.

Construtores

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

Propriedades

ActiveRecord	Registro exibido atualmente no documento mesclado. Representa a seguinte marca de elemento no esquema: w:activeRecord.
AddressFieldName	Coluna contendo endereço de email. Representa a seguinte marca de elemento no esquema: w:addressFieldName.
CheckErrors	Configuração de relatório de erro de mesclagem de email. Representa a seguinte marca de elemento no esquema: w:checkErrors.
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
ConnectString	Cadeia de conexão de fonte de dados. Representa a seguinte marca de elemento no esquema: w:connectString.
DataSourceObject	Configurações de objeto da fonte de dados do Office. Representa a seguinte marca de elemento no esquema: w:odso.
DataSourceReference	Caminho do arquivo de fonte de dados. Representa a seguinte marca de elemento no esquema: w:dataSource.
DataType	Tipo de fonte de dados. Representa a seguinte marca de elemento no esquema: w:dataType.
Destination	Destino do documento mesclado. Representa a seguinte marca de elemento no esquema: w:destination.
DoNotSuppressBlankLines	Remova linhas em branco de documentos mesclados. Representa a seguinte marca de elemento no esquema: w:doNotSuppressBlankLines.
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)
HeaderSource	Caminho do arquivo de definição de cabeçalho. Representa a seguinte marca de elemento no esquema: w:headerSource.
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)
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)
LinkToQuery	A consulta contém link para o arquivo de consulta externa. Representa a seguinte marca de elemento no esquema: w:linkToQuery.
LocalName	Obtém o nome local do elemento atual. (Herdado de OpenXmlElement)
MailAsAttachment	Documento mesclado ao anexo de email. Representa a seguinte marca de elemento no esquema: w:mailAsAttachment.
MailSubject	E-mail mesclado ou Linha de Assunto de Fax. Representa a seguinte marca de elemento no esquema: w:mailSubject.
MainDocumentType	Tipo de documento de origem. Representa a seguinte marca de elemento no esquema: w:mainDocumentType.
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)
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)
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)
Parent	Obtém o elemento pai do elemento atual. (Herdado de OpenXmlElement)
Prefix	Obtém o prefixo namespace do elemento atual. (Herdado de OpenXmlElement)
Query	Consulta para a mesclagem de registros de fonte de dados. Representa a seguinte marca de elemento no esquema: w:query.
ViewMergedData	Exibir dados mesclados no documento. Representa a seguinte marca de elemento no esquema: w:viewMergedData.
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()	Configurações de mesclagem de email. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:mailMerge. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)