RecipientData Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Wordprocessing

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Datos sobre el registro de origen de datos único.

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

Cuando el objeto se serializa como xml, su nombre completo es w:recipientData.

public class RecipientData : DocumentFormat.OpenXml.OpenXmlCompositeElement

type RecipientData = class
    inherit OpenXmlCompositeElement

Public Class RecipientData
Inherits OpenXmlCompositeElement

Herencia

Object

OpenXmlElement

OpenXmlCompositeElement

RecipientData

Comentarios

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

recipientData (datos sobre el registro de origen de datos único)

Este elemento especifica información sobre un único registro dentro de un origen de datos externo. Si un registro se combinará en un documento combinado, no se necesita información sobre ese registro dentro de esta parte. Sin embargo, si un registro determinado no se combinará en un documento combinado, el valor de la clave única de ese registro se almacenará en el elemento uniqueTag como elemento secundario de este elemento (junto con el elemento activo) para indicar esta exclusión.

[Nota: Esta asignación es necesaria en lugar de simplemente usar el orden de elemento para corresponder a los índices de registro en el origen de datos externo, ya que los registros se pueden agregar o eliminar de orígenes de datos externos, y se debe proporcionar un medio para mantener datos específicos del registro externo WordprocessingML como los especificados en el elemento activo (§17.14.1) y el registro de datos externo correspondiente cuando el documento WordprocessingML se vuelve a conectar al origen de datos externo; independientemente del origen de datos externo; ordenación de los registros dentro del origen de datos externo. En otras palabras, este elemento y sus elementos secundarios permiten que los documentos WordprocessingML combinados mantengan la relación entre los registros dentro de datos externos y los parámetros WordprocessingML específicos del registro. Fin de la nota]

[Ejemplo: considere la posibilidad de un documento WordprocessingML combinado que:

Se ha conectado a un origen de datos externo especificado que contiene tres registros; Y

La aplicación de hospedaje ha configurado para no rellenar un documento combinado con el registro que pertenece a John Smith en el origen de datos externo.

Tenga en cuenta también que la primera vez que el documento WordprocessingML determinado se conectó al origen de datos externo, el registro de John Smith estaba en el segundo registro del origen de datos.

Cuando este documento combinado está conectado al origen de datos externo, el elemento recipientData se puede usar para almacenar el número y el valor de la columna que contiene la clave única para cada registro de datos dentro del origen de datos externo, incluido el de John Smith. Esta configuración se representa mediante el siguiente WordprocessingML para usar los códigos hash dentro del elemento recipientData para identificar de forma única los tres registros dentro del origen de datos externo.

<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>  

En este caso, el primer, segundo (registro de John Smith) y los terceros registros del origen de datos especificado cuyos valores de clave únicos se 1408613399, 870254691 y 1107777181 se han asociado a los datos de destinatario a través del elemento activo para especificar que el registro asociado al registro determinado (registro de John Smith) no se debe usar para rellenar un documento WordprocessingML combinado.

Con estas asociaciones en su lugar, si se agrega un cuarto registro al origen de datos externo especificado por encima del registro de John Smith, cuando el documento WordprocessingML combinado determinado se vuelve a conectar al origen de datos externo, la aplicación de hospedaje todavía sabe que el registro de John Smith no debe usarse para rellenar un documento WordprocessingML combinado, ya que está asociado a través de su valor de clave único y no depende de la posición ordinal del registro determinado dentro de la externa. origen de datos. Fin del ejemplo]

Elementos primarios
Elemento raíz de la parte Datos de destinatario de combinación de correspondencia WordprocessingML; destinatarios (§17.14.29)

Elementos secundarios	Subclause
active (el registro se incluye en la combinación de correspondencia)	§17.14.1
column (índice de columna que contiene valores únicos para record)	§17.14.7
uniqueTag (valor único para el registro)	§17.14.35

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

ISO/IEC29500: 2008.

Constructores

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

Propiedades

Active	El registro se incluye en la combinación de correspondencia. Representa la siguiente etiqueta de elemento en el esquema: w:active.
ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
ColumnIndex	Índice de columna que contiene valores únicos para el registro. Representa la siguiente etiqueta de elemento en el esquema: w:column.
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)
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)
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)
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)
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)
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)
UniqueTag	Valor único para record. Representa la siguiente etiqueta de elemento en el esquema: w:uniqueTag.
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()	Datos sobre el registro de origen de datos único. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es w:recipientData. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)