SubDocumentReference Classe

Définition

Espace de noms:

DocumentFormat.OpenXml.Wordprocessing

Assembly:

DocumentFormat.OpenXml.dll

Paquet:

DocumentFormat.OpenXml v3.0.1

Ancre pour l’emplacement du sous-document.

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 :subDoc.

public class SubDocumentReference : DocumentFormat.OpenXml.Wordprocessing.RelationshipType

type SubDocumentReference = class
    inherit RelationshipType

Public Class SubDocumentReference
Inherits RelationshipType

Héritage

Object

OpenXmlElement

OpenXmlLeafElement

RelationshipType

SubDocumentReference

Remarques

[ISO/IEC 29500-1 1st Edition]

subDoc (Anchor for Subdocument Location)

Cet élément spécifie un emplacement dans un document master pour l’insertion du contenu d’un sous-document spécifié. Le contenu du sous-document spécifié doit apparaître à l’emplacement spécifié dans le document master, selon les besoins, mais doit faire partie du fichier distinct spécifié par l’emplacement du sous-document. L’emplacement du sous-document doit être spécifié par la relation dont l’attribut Id correspond à l’attribut id sur cet élément.

Si le type de relation de la relation spécifiée par cet élément n’est pas http://schemas.openxmlformats.org/officeDocument/2006/subDocument, n’est pas présent ou n’a pas la valeur d’attribut TargetMode External, le document est considéré comme non conforme.

Lorsqu’un sous-document est affiché à l’emplacement spécifié dans le document master, la logique suivante détermine comment les styles et la mise en forme du sous-document et du document master associé doivent être gérés :

• Toute la mise en forme directe dans le sous-document est conservée.

• Pour chaque style dans chaque sous-document :

S’il existe un style avec la même valeur d’attribut styleId dans le document master, affichez le contenu du sous-document à l’aide du style dans le document master.

Sinon, importez le style dans le document master et affichez le contenu à l’aide du style d’origine.

Si un sous-document suivant contient également un style avec la même valeur d’attribut styleId, le style de ce dernier est ignoré et le contenu est affiché à l’aide de la version du style importée dans le document master.

[Exemple : Prenons un livre composé de trois chapitres, dont deux ont été divisés en sous-documents comme suit (le rectangle rouge indique les limites du contenu de chaque sous-document) :

35b1894c-1477-4693-aeec-f0baccc69f21

Le document master résultant se composerait de son propre contenu WordprocessingML, ainsi que des ancres de sous-documents aux emplacements appropriés :

<w:body>  
  <w:p>  
    …    <w:r>  
      <w:t>My Book</w:t>  
    </w:r>  
  </w:p>  
  <w:p>  
    <w:r>  
      <w:t>Once upon a time…</w:t>  
    </w:r>  
  </w:p>  
  <w:p>  
    <w:subDoc r:id="subDocRel1" />  
  </w:p>  
  <w:p>  
    <w:subDoc r:id="subDocRel2" />  
  </w:p>  
  <w:sectPr>  
    …  </w:sectPr>  
</w:body>  

Les deux éléments subDoc spécifient que les sous-documents ciblés par les relations avec un ID subDocRel1 et subDocRel2 doivent être importés dans cet ordre après le contenu des deux premiers paragraphes du contenu. En examinant le contenu de l’élément de partie de relation correspondant, nous pouvons voir les cibles pour ces relations :

<Relationships … >  
  …  <Relationship Id="subDocRel1" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter1.docx" />  
  <Relationship Id="subDocRel2" TargetMode="External" Type="http://schemas.openxmlformats.org/officeDocument/2006/relationships/subDocument" Target="Chapter2.docx" />  
  …</Relationships>  

L’élément de partie de relation correspondant indique que les deux fichiers à importer se trouvent au même emplacement que le fichier et le nom actuels Chapter1.docx et Chapter2.docx respectivement. Fin de l’exemple]

Éléments parents
bdo (§17.3.2.3) ; customXml (§17.5.1.3) ; dir (§17.3.2.8) ; fldSimple (§17.16.19) ; lien hypertexte (§17.16.22) ; p (§17.3.1.22) ; sdtContent (§17.5.2.36) ; smartTag (§17.5.1.9)

[Remarque : La définition de schéma XML W3C du modèle de contenu de cet élément (CT_Rel) se trouve dans §A.1. Fin de la remarque]

ISO/IEC29500 : 2008.

Constructeurs

SubDocumentReference()

Initialise une nouvelle instance de la classe SubDocumentReference.

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 RelationshipType)
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	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)
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()	Ancre pour l’emplacement du sous-document. 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 :subDoc. (Hérité de OpenXmlElement)
IEnumerable<OpenXmlElement>.GetEnumerator()	Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement)