HeaderReference Classe
Définition
Important
Certaines informations portent sur la préversion du produit qui est susceptible d’être en grande partie modifiée avant sa publication. Microsoft exclut toute garantie, expresse ou implicite, concernant les informations fournies ici.
Référence d’en-tête.
Cette classe est disponible dans Office 2007 et versions ultérieures.
Lorsque l’objet est sérialisé au format xml, son nom qualifié est w :headerReference.
public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(23, "headerReference")]
public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.SchemaAttr(23, "headerReference")]
public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.SchemaAttr("w:headerReference")]
public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceType[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class HeaderReference : DocumentFormat.OpenXml.Wordprocessing.HeaderFooterReferenceTypetype HeaderReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(23, "headerReference")>]
type HeaderReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.SchemaAttr(23, "headerReference")>]
type HeaderReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.SchemaAttr("w:headerReference")>]
type HeaderReference = class
inherit HeaderFooterReferenceType[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type HeaderReference = class
inherit HeaderFooterReferenceTypePublic Class HeaderReference
Inherits HeaderFooterReferenceType- Héritage
- Héritage
- Attributs
Remarques
[ISO/IEC 29500-1 1st Edition]
headerReference (Header Reference)
Cet élément spécifie un en-tête unique qui doit être associé à la section active du document. Cet en-tête doit être référencé via l’attribut id, qui spécifie une relation explicite au composant En-tête approprié dans le package WordprocessingML.
Si le type de relation de la relation spécifiée par cet élément n’est pas http://schemas.openxmlformats.org/officeDocument/2006/header, n’est pas présent ou n’a pas de valeur d’attribut TargetMode Interne, le document est considéré comme non conforme.
Dans chaque section d’un document, il peut y avoir jusqu’à trois types d’en-têtes différents :
Premier en-tête de page
En-tête de page impaire
En-tête de page paire
Le type d’en-tête spécifié par le headerReference actif est spécifié via l’attribut type.
Si un type d’en-tête est omis pour une section donnée, les règles suivantes s’appliquent.
Si aucun en-tête headerReference n’est spécifié pour le premier en-tête de page et que l’élément titlePg est spécifié, le premier en-tête de page est hérité de la section précédente ou, s’il s’agit de la première section du document, un nouvel en-tête vide est créé. Si l’élément titlePg n’est pas spécifié, aucun premier en-tête de page ne doit être affiché et l’en-tête de page impair doit être utilisé à sa place.
Si aucun headerReference n’est spécifié pour l’en-tête de page paire et que l’élément evenAndOddHeaders est spécifié, l’en-tête de page paire est hérité de la section précédente ou, s’il s’agit de la première section du document, un nouvel en-tête vide est créé. Si l’élément evenAndOddHeaders n’est pas spécifié, aucun en-tête de page pair ne doit être affiché et l’en-tête de page impair doit être utilisé à sa place.
Si aucun headerReference n’est spécifié pour l’en-tête de page impaire, l’en-tête de page paire doit être hérité de la section antérieure. Toutefois, s’il s’agit de la première section du document, un en-tête vide doit être créé.
[Exemple : voici la définition d’un document de trois pages comportant un premier en-tête de page, un en-tête de page impaire et un en-tête de page paire qui sont distincts :
f290aae3-2d0e-46b2-9a84-7e59757bc879
Ce document définit trois en-têtes, chacun ayant une relation à partir du composant de document avec un ID de relation unique, comme illustré dans le balisage d’empaquetage suivant :
<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>
Ces relations sont ensuite référencées dans les propriétés de la section à l’aide de la syntaxe WordprocessingML suivante :
<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 section obtenue doit utiliser la partie d’en-tête avec l’ID de relation rId3 pour la première page, la partie d’en-tête avec l’ID de relation rId2 pour toutes les pages paires suivantes et la partie d’en-tête avec l’ID de relation rId5 pour toutes les pages impaires suivantes. Fin de l’exemple]
| Éléments parents |
|---|
| sectPr (§17.6.17) ; sectPr (§17.6.18) |
[Remarque : La définition de schéma XML W3C du modèle de contenu de cet élément (CT_HdrFtrRef) se trouve dans §A.1. Fin de la remarque]
ISO/IEC29500 : 2008.
Constructeurs
| HeaderReference() |
Initialise une nouvelle instance de la classe HeaderReference. |
Propriétés
| ChildElements |
Obtient tous les nœuds enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| ExtendedAttributes |
Obtient tous les attributs étendus (attributs non définis dans le schéma) de l’élément actuel. (Hérité de OpenXmlElement) |
| Features |
Obtient un IFeatureCollection pour l’élément actuel. Cette collection de fonctionnalités sera en lecture seule, mais héritera des fonctionnalités de sa partie parente et de son package, le cas échéant. (Hérité de OpenXmlElement) |
| FirstChild |
Obtient le premier enfant de l’élément OpenXmlElement. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement de ce type. (Hérité de OpenXmlElement) |
| HasAttributes |
Obtient une valeur indiquant si l’élément actuel a des attributs. (Hérité de OpenXmlElement) |
| HasChildren |
Obtient une valeur qui indique si l’élément actuel a des éléments enfants. (Hérité de OpenXmlLeafElement) |
| Id |
Relation au composant Représente l’attribut suivant dans le schéma : r :id (Hérité de HeaderFooterReferenceType) |
| InnerText |
Obtient ou définit les valeurs concaténées du nœud et de tous ses enfants. (Hérité de OpenXmlElement) |
| InnerXml |
Obtient ou définit le balisage qui représente uniquement les éléments enfants de l’élément actuel. (Hérité de OpenXmlLeafElement) |
| LastChild |
Obtient le dernier enfant de l’élément OpenXmlElement. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement de ce type. (Hérité de OpenXmlElement) |
| LocalName |
Référence d’en-tête. Cette classe est disponible dans Office 2007 et versions ultérieures. Lorsque l’objet est sérialisé au format xml, son nom qualifié est w :headerReference. |
| LocalName |
Obtient le nom local de l’élément actuel. (Hérité de OpenXmlElement) |
| MCAttributes |
Obtient ou définit les attributs de compatibilité du balisage. Retourne null si aucun attribut de compatibilité de balisage n’est défini pour l’élément actuel. (Hérité de OpenXmlElement) |
| NamespaceDeclarations |
Obtient toutes les déclarations d’espace de noms définies dans l’élément actuel. Retourne un énumérateur vide s’il n’y a pas de déclaration d’espace de noms. (Hérité de OpenXmlElement) |
| NamespaceUri |
Obtient l’URI d’espace de noms de l’élément actuel. (Hérité de OpenXmlElement) |
| OpenXmlElementContext |
Obtient l’élément OpenXmlElementContext de l’élément actuel. (Hérité de OpenXmlElement) |
| OuterXml |
Obtient le balisage qui représente l’élément actuel et tous ses éléments enfants. (Hérité de OpenXmlElement) |
| Parent |
Obtient l’élément parent de l’élément actuel. (Hérité de OpenXmlElement) |
| Prefix |
Obtient le préfixe d’espace de noms de l’élément actuel. (Hérité de OpenXmlElement) |
| Type |
type Représente l’attribut suivant dans le schéma : w :type (Hérité de HeaderFooterReferenceType) |
| XmlQualifiedName |
Obtient le nom qualifié de l’élément actuel. (Hérité de OpenXmlElement) |
| XName |
Obtient le nom qualifié de l’élément actuel. (Hérité de OpenXmlElement) |
Méthodes
| AddAnnotation(Object) |
Ajoute un objet à la liste d’annotations de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| AddNamespaceDeclaration(String, String) |
Ajoute une déclaration d’espace de noms au nœud actuel. (Hérité de OpenXmlElement) |
| Ancestors() |
Énumère tous les ancêtres de l’élément actuel. (Hérité de OpenXmlElement) |
| Ancestors<T>() |
Énumère uniquement les ancêtres de l’élément actuel qui ont le type spécifié. (Hérité de OpenXmlElement) |
| Annotation(Type) |
Obtenez le premier objet d’annotation du type spécifié à partir de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| Annotation<T>() |
Obtenez le premier objet d’annotation du type spécifié à partir de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| Annotations(Type) |
Obtient une collection d’annotations avec le type spécifié pour l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| Annotations<T>() |
Obtient une collection d’annotations avec le type spécifié pour l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| Append(IEnumerable<OpenXmlElement>) |
Ajoute chaque élément d’une liste d’éléments à la fin de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| Append(OpenXmlElement[]) |
Ajoute chaque élément d’un tableau d’éléments à la fin de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| AppendChild<T>(T) |
Ajoute l’élément spécifié à la fin de la liste des nœuds enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| ClearAllAttributes() |
Efface tous les attributs, y compris les attributs connus et les attributs étendus. (Hérité de OpenXmlElement) |
| Clone() |
Crée un doublon du nœud actuel. (Hérité de OpenXmlElement) |
| CloneNode(Boolean) |
Crée un doublon de ce nœud. |
| Descendants() |
Énumère tous les descendants de l’élément actuel. (Hérité de OpenXmlElement) |
| Descendants<T>() |
Énumérez tous les descendants de l’élément actuel de type T. (Hérité de OpenXmlElement) |
| Elements() |
Énumère tous les enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| Elements<T>() |
Énumère uniquement les enfants de l’élément actuel qui ont le type spécifié. (Hérité de OpenXmlElement) |
| ElementsAfter() |
Énumère tous les éléments frères qui suivent l’élément actuel et ont le même parent que l’élément actuel. (Hérité de OpenXmlElement) |
| ElementsBefore() |
Énumère tous les éléments frères qui précèdent l’élément actuel et ont le même parent que l’élément actuel. (Hérité de OpenXmlElement) |
| GetAttribute(String, String) |
Obtient un attribut Open XML avec le nom de balise et l’URI d’espace de noms spécifiés. (Hérité de OpenXmlElement) |
| GetAttributes() |
Obtient une liste qui contient une copie de tous les attributs. (Hérité de OpenXmlElement) |
| GetEnumerator() |
Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement) |
| GetFirstChild<T>() |
Recherche le premier élément enfant de type T. (Hérité de OpenXmlElement) |
| InsertAfter<T>(T, OpenXmlElement) |
Insère l’élément spécifié immédiatement après l’élément de référence spécifié. (Hérité de OpenXmlElement) |
| InsertAfterSelf<T>(T) |
Insère l’élément spécifié immédiatement après l’élément actuel. (Hérité de OpenXmlElement) |
| InsertAt<T>(T, Int32) |
Insère l’élément spécifié à l’index spécifié dans la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| InsertBefore<T>(T, OpenXmlElement) |
Insère l’élément spécifié juste avant l’élément de référence spécifié. (Hérité de OpenXmlElement) |
| InsertBeforeSelf<T>(T) |
Insère l’élément spécifié juste avant l’élément actuel. (Hérité de OpenXmlElement) |
| IsAfter(OpenXmlElement) |
Détermine si l’élément actuel apparaît après un élément spécifié dans l’ordre du document. (Hérité de OpenXmlElement) |
| IsBefore(OpenXmlElement) |
Détermine si l’élément actuel apparaît avant un élément spécifié dans l’ordre du document. (Hérité de OpenXmlElement) |
| LookupNamespace(String) |
Résout le préfixe d’espace de noms dans le contexte du nœud actuel. (Hérité de OpenXmlElement) |
| LookupPrefix(String) |
Recherche le préfixe correspondant pour un URI d’espace de noms dans l’étendue de l’élément actuel. (Hérité de OpenXmlElement) |
| NextSibling() |
Obtient l’élément OpenXmlElement qui suit immédiatement l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement suivant. (Hérité de OpenXmlElement) |
| NextSibling<T>() |
Obtient l’élément OpenXmlElement avec le type spécifié qui suit l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’y a pas d’élément OpenXmlElement suivant. (Hérité de OpenXmlElement) |
| PrependChild<T>(T) |
Insère l’élément spécifié au début de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| PreviousSibling() |
Obtient l’élément OpenXmlElement qui précède immédiatement l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic ) s’il n’existe aucun élément OpenXmlElement précédent. (Hérité de OpenXmlElement) |
| PreviousSibling<T>() |
Obtient l’élément OpenXmlElement avec le type spécifié qui précède l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement précédent. (Hérité de OpenXmlElement) |
| Remove() |
Supprime l’élément actuel de son parent. (Hérité de OpenXmlElement) |
| RemoveAllChildren() |
Supprime tous les éléments enfants de l’élément actuel. (Hérité de OpenXmlLeafElement) |
| RemoveAllChildren<T>() |
Supprimez tous les éléments enfants de l’élément actuel qui sont de type T. (Hérité de OpenXmlElement) |
| RemoveAnnotations(Type) |
Supprime les annotations du type spécifié de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| RemoveAnnotations<T>() |
Supprime les annotations avec le type spécifié de l’élément OpenXmlElement actuel. (Hérité de OpenXmlElement) |
| RemoveAttribute(String, String) |
Supprime l’attribut de l’élément actuel. (Hérité de OpenXmlElement) |
| RemoveChild<T>(T) |
Supprime l’élément enfant spécifié de la liste des éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| RemoveNamespaceDeclaration(String) |
Supprime la déclaration d’espace de noms pour le préfixe spécifié. Ne supprime rien s’il n’y a pas de préfixe. (Hérité de OpenXmlElement) |
| ReplaceChild<T>(OpenXmlElement, T) |
Remplace un élément enfant par un autre élément enfant dans la liste d’éléments enfants de l’élément actuel. (Hérité de OpenXmlElement) |
| SetAttribute(OpenXmlAttribute) |
Définit un attribut sur l’élément spécifié. Si l’attribut est un attribut connu, la valeur de l’attribut est définie. Si l’attribut est un attribut étendu, l’attribut « openxmlAttribute » est ajouté à la liste des attributs étendus. (Hérité de OpenXmlElement) |
| SetAttributes(IEnumerable<OpenXmlAttribute>) |
Définit un certain nombre d’attributs à l’élément . Si un attribut est un attribut connu, la valeur de l’attribut est définie. Si un attribut est un attribut étendu, l’attribut « openxmlAttribute » est ajouté à la liste des attributs étendus. (Hérité de OpenXmlElement) |
| WriteTo(XmlWriter) |
Enregistre le nœud actuel dans le XmlWriter spécifié. (Hérité de OpenXmlElement) |
Implémentations d’interfaces explicites
| IEnumerable.GetEnumerator() |
Référence d’en-tête. Cette classe est disponible dans Office 2007 et versions ultérieures. Lorsque l’objet est sérialisé au format xml, son nom qualifié est w :headerReference. (Hérité de OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement) |