HeaderReference Clase

Definición

Espacio de nombres:

DocumentFormat.OpenXml.Wordprocessing

Ensamblado:

DocumentFormat.OpenXml.dll

Paquete:

DocumentFormat.OpenXml v3.0.1

Referencia de encabezado.

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

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

public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType

type HeaderReference = class
    inherit HeaderFooterReferenceType

Public Class HeaderReference
Inherits HeaderFooterReferenceType

Herencia

Object

OpenXmlElement

OpenXmlLeafElement

HeaderFooterReferenceType

HeaderReference

Comentarios

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

headerReference (Header Reference)

Este elemento especifica un único encabezado, que se debe asociar con la sección actual del documento. Se debe hacer referencia a este encabezado a través del atributo id, que especifica una relación explícita a la parte de encabezado adecuada en el paquete WordprocessingML.

Si el tipo de relación de la relación especificada por este elemento no es , no http://schemas.openxmlformats.org/officeDocument/2006/headerestá presente o no tiene un valor de atributo TargetMode de Internal, el documento se considerará no conforme.

Dentro de cada sección de un documento puede haber hasta tres tipos diferentes de encabezados:

• Encabezado en primera página

• Encabezado en página impar

• Encabezado en página par

El tipo de encabezado que indica el elemento headerReference actual se especifica a través del atributo type.

Si se omite un tipo de encabezado en una sección determinada, se deben aplicar las siguientes reglas.

• Si no se especifica ningún elemento headerReference para el encabezado en primera página y el elemento titlePg está especificado, el encabezado en primera página debe heredarse de la sección anterior; o bien, si se trata de la primera sección del documento, se deberá crear un nuevo encabezado en blanco. Si no se especifica el elemento titlePg, no se mostrará ningún encabezado en la primera página y se usará el encabezado de las páginas pares en su lugar.

• Si no se especifica ningún elemento headerReference para el encabezado en página par y el elemento evenAndOddHeaders está especificado, el encabezado en página par debe heredarse de la sección anterior; o bien, si se trata de la primera sección del documento, se deberá crear un nuevo encabezado en blanco. Si no se especifica el elemento evenAndOddHeaders, no se mostrará ningún encabezado en las páginas pares y se usará el encabezado de las páginas impares en su lugar.

• Si no se especifica ningún elemento headerReference para el encabezado en página impar, el encabezado en página par debe heredarse de la sección anterior; o bien, si se trata de la primera sección del documento, se deberá crear un nuevo encabezado en blanco.

[Ejemplo: considere un documento de tres páginas con diferentes encabezados para la primera página, la página impar y la página par definidos de la siguiente manera:

f290aae3-2d0e-46b2-9a84-7e59757bc879

En este documento se definen tres encabezados, cada uno de los cuales tiene una relación de la parte del documento con un identificador de relación único, como se muestra en el siguiente marcado de empaquetado:

<Relationships xmlns="http://schemas.openxmlformats.org/package/2006/relationships">  
  …  
  <Relationship Id="rId2" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header1.xml" />  
  <Relationship Id="rId3" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header2.xml" />  
  <Relationship Id="rId5" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/header" Target="header3.xml" />  
  …  
</Relationships>  

A continuación, se hace referencia a estas relaciones en las propiedades de la sección mediante el siguiente WordprocessingML:

<w:sectPr>  
  …  
  <w:headerReference r:id="rId3" w:type="first" />  
  <w:headerReference r:id="rId5" w:type="default" />  
  <w:headerReference r:id="rId2" w:type="even" />  
  …  
</w:sectPr>  

La sección resultante debe usar el elemento de encabezado con id. de relación rId3 para la primera página, el elemento de encabezado con id . de relación rId2 para todas las páginas pares posteriores y el elemento de encabezado con id. de relación rId5 para todas las páginas impares posteriores. Fin del ejemplo]

Elementos primarios
sectPr (§17.6.17); sectPr (§17.6.18)

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

ISO/IEC29500: 2008.

Constructores

HeaderReference()

Inicializa una nueva instancia de la clase HeaderReference.

Propiedades

ChildElements	Obtiene todos los nodos secundarios del elemento actual. (Heredado de OpenXmlElement)
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. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement de este tipo. (Heredado de OpenXmlElement)
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 OpenXmlLeafElement)
Id	Relación con el elemento Representa el atributo siguiente en el esquema: r:id (Heredado de HeaderFooterReferenceType)
InnerText	Obtiene o establece los valores concatenados del nodo y todos sus elementos secundarios. (Heredado de OpenXmlElement)
InnerXml	Obtiene o establece el marcado que solo representa elementos secundarios del elemento actual. (Heredado de OpenXmlLeafElement)
LastChild	Obtiene el último elemento secundario del elemento OpenXmlElement. Devuelve null (Nothing en Visual Basic) si no hay ningún elemento OpenXmlElement de este tipo. (Heredado de OpenXmlElement)
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)
Type	type Representa el atributo siguiente en el esquema: w:type (Heredado de HeaderFooterReferenceType)
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)
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 OpenXmlElement)
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 OpenXmlElement)
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 en la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
InsertBefore<T>(T, OpenXmlElement)	Inserta el elemento especificado inmediatamente antes del elemento de referencia especificado. (Heredado de OpenXmlElement)
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 elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
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 OpenXmlLeafElement)
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 de la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
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 un elemento secundario por otro elemento secundario en la lista de elementos secundarios del elemento actual. (Heredado de OpenXmlElement)
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()	Referencia de encabezado. Esta clase está disponible en Office 2007 y versiones posteriores. Cuando el objeto se serializa como xml, su nombre completo es w:headerReference. (Heredado de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Devuelve un enumerador que recorre en iteración la colección secundaria. (Heredado de OpenXmlElement)