RecipientData Classe

Definição

Namespace:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Pacote:

DocumentFormat.OpenXml v3.0.1

Dados sobre o registro de fonte de dados único.

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

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

public class RecipientData : DocumentFormat.OpenXml.OpenXmlCompositeElement

type RecipientData = class
    inherit OpenXmlCompositeElement

Public Class RecipientData
Inherits OpenXmlCompositeElement

Herança

Object

OpenXmlElement

OpenXmlCompositeElement

RecipientData

Comentários

[ISO/IEC 29500-1 1st Edition]

recipientData (Data About Single Data Source Record)

Esse elemento especifica informações sobre um único registro dentro de uma fonte de dados externa. Se um registro for mesclado em um documento mesclado, nenhuma informação será necessária sobre esse registro nesta parte. No entanto, se um determinado registro não for mesclado em um documento mesclado, o valor da chave exclusiva para esse registro será armazenado dentro do elemento uniqueTag como filho desse elemento (juntamente com o elemento ativo) para indicar essa exclusão.

[Observação: esse mapeamento é necessário no lugar de simplesmente usar a ordem de elemento para corresponder aos índices de registro na fonte de dados externa, pois os registros podem ser adicionados ou excluídos de fontes de dados externas, e um meio deve ser fornecido para manter dados específicos do registro externo wordprocessingML como os especificados no elemento ativo (§17.14.1) e o registro de dados externos correspondente quando o documento WordprocessingML é reconectado à fonte de dados externa; independentemente de a ordenação dos registros na fonte de dados externa. Em outras palavras, esse elemento e seus elementos filho permitem que documentos wordprocessingML mesclados mantenham a relação entre os registros dentro de dados externos e registrem parâmetros wordprocessingML específicos. nota final]

[Exemplo: considere um documento wordprocessingML mesclado que:

Foi conectado a uma fonte de dados externa especificada que contém três registros; E

Foi configurado pelo aplicativo de hospedagem para não preencher um documento mesclado com o registro relativo a John Smith na fonte de dados externa.

Considere também que na primeira vez que o documento WordprocessingML foi conectado à fonte de dados externa, o registro de John Smith estava no segundo registro na fonte de dados.

Quando este documento mesclado estiver conectado à fonte de dados externa, o elemento recipientData poderá ser usado para armazenar o número e o valor da coluna que contém a chave exclusiva para cada registro de dados na fonte de dados externa, incluindo a de John Smith. Essa configuração é representada usando o WordprocessingML a seguir para usar os códigos de hash dentro do elemento recipientData para identificar exclusivamente os três registros dentro da fonte de dados externa.

<w:recipientData>  
  <w:column w:val="1" />  
  <w:uniqueTag>  
1408613399</w:uniqueTag>   
</w:recipientData>  
<w:recipientData>  
  <w:active w:val="0" />  
  <w:column w:val="1" />  
  <w:uniqueTag>  
870254691</w:uniqueTag>   
</w:recipientData>  
<w:recipientData>  
  <w:column w:val="1" />  
  <w:uniqueTag>  
1107777181</w:uniqueTag>   
</w:recipientData>  

Aqui, o primeiro, o segundo (registro de John Smith) e o terceiro registros dentro da fonte de dados especificada cujos valores de chave exclusivos são 1408613399, 870254691 e 1107777181 foram associados aos dados do destinatário por meio do elemento ativo para especificar que o registro associado ao registro determinado (registro de John Smith) não deve ser usado para preencher um documento wordprocessingML mesclado.

Com essa associação em vigor, se um quarto registro for adicionado à fonte de dados externa fornecida acima do registro de John Smith, quando o documento WordprocessingML mesclado é reconectado à fonte de dados externa, o aplicativo de hospedagem ainda sabe que o registro de John Smith não deve ser usado para preencher um documento WordprocessingML mesclado, pois ele está associado por meio de seu valor de chave exclusivo e não depende da posição ordinal do registro fornecido dentro do documento externo fonte de dados. exemplo final]

Elementos pai
Elemento raiz da parte dados do destinatário do WordprocessingML Mail Merge; destinatários (§17.14.29)

Elementos filho	Subclause
ativo (o registro está incluído na mesclagem de email)	§17.14.1
coluna (Índice de coluna que contém valores exclusivos para registro)	§17.14.7
uniqueTag (valor exclusivo para registro)	§17.14.35

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

ISO/IEC29500: 2008.

Construtores

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

Propriedades

Active	O registro está incluído na mesclagem de email. Representa a seguinte marca de elemento no esquema: w:active.
ChildElements	Obtém todos os nós filho do elemento atual. (Herdado de OpenXmlElement)
ColumnIndex	Índice de coluna que contém valores exclusivos para registro. Representa a seguinte marca de elemento no esquema: w:column.
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)
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)
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)
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)
UniqueTag	Valor exclusivo para registro. Representa a seguinte marca de elemento no esquema: w:uniqueTag.
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()	Dados sobre o registro de fonte de dados único. Essa classe está disponível no Office 2007 e superior. Quando o objeto é serializado como xml, seu nome qualificado é w:recipientData. (Herdado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retorna um enumerador que itera por meio da coleção filho. (Herdado de OpenXmlElement)