Captions 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.
Paramètres de légende.
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 :captions.
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
[DocumentFormat.OpenXml.SchemaAttr(23, "captions")]
public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElementpublic class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr(23, "captions")]
public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr("w:captions")]
public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.SchemaAttr("w:captions")]
public class Captions : DocumentFormat.OpenXml.TypedOpenXmlCompositeElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))]
public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))]
[DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))]
[DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)]
public class Captions : DocumentFormat.OpenXml.OpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
[<DocumentFormat.OpenXml.SchemaAttr(23, "captions")>]
type Captions = class
inherit OpenXmlCompositeElementtype Captions = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr(23, "captions")>]
type Captions = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr("w:captions")>]
type Captions = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.SchemaAttr("w:captions")>]
type Captions = class
inherit TypedOpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))>]
type Captions = class
inherit OpenXmlCompositeElement[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.Caption))>]
[<DocumentFormat.OpenXml.ChildElementInfo(typeof(DocumentFormat.OpenXml.Wordprocessing.AutoCaptions))>]
[<DocumentFormat.OpenXml.OfficeAvailability(DocumentFormat.OpenXml.FileFormatVersions.Office2007)>]
type Captions = class
inherit OpenXmlCompositeElementPublic Class Captions
Inherits OpenXmlCompositeElementPublic Class Captions
Inherits TypedOpenXmlCompositeElement- Héritage
- Héritage
- Attributs
Remarques
[ISO/IEC 29500-1 1st Edition]
captions (Caption Settings)
Cet élément spécifie la présence d’informations sur les légendes dans un document WordprocessingML donné. Ces informations sont divisées en deux composants :
L’élément enfant légende définit le format d’un seul type de légende à ajouter automatiquement au document.
L’élément enfant autoCaptions définit les types d’objets auxquels un format légende doit être appliqué automatiquement.
Ces informations doivent être utilisées pour déterminer les légendes qui sont automatiquement ajoutées aux objets lorsqu’ils sont insérés dans un document WordprocessingML. [Remarque : ce paramètre est généralement ignoré, sauf s’il est spécifié dans le modèle par défaut d’une application. Fin de la remarque]
[Exemple : Considérez le diagramme ci-dessous illustrant un document WordprocessingML contenant un tableau étiqueté avec un légende :
9512a3b0-3be8-461e-b333-2dafe873ea54
Dans ce diagramme, la table contenue dans le document WordprocessingML a été étiquetée en insérant un légende sous le tableau composé de la chaîne Table suivie d’un nombre décimal. Ce format de légende inséré automatiquement est spécifié à l’aide du wordprocessingML suivant :
<w:captions>
<w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />
</w:captions>
Ici, l’élément captions spécifie la présence d’un ou de plusieurs formats légende dans un document WordprocessingML donné avec son élément enfant légende. Plus précisément, l’élément enfant légende spécifie un type unique de légende à utiliser dans le document WordprocessingML. Fin de l’exemple]
Le sous-titrage utilise les champs (§17.16.5) pour étiqueter les objets en faisant référence à :
Autres objets sous-titrés dans un document donné
Autres objets sous-titrés dans le même chapitre dans un document donné (lorsque des numéros de chapitre sont ajoutés en spécifiant l’attribut chapNum sur le type légende. Un chapitre est une section de texte dans un document WordprocessingML précédée d’un contenu avec un style qui a été spécifié par pour délimiter les chapitres dans les documents. Un seul style peut être spécifié comme style utilisé pour un type de légende unique pour délimiter les chapitres d’un document. Un chapitre se termine immédiatement au-dessus du instance de contenu suivant avec le style utilisé pour délimiter les chapitres.
[Exemple : Considérez le diagramme ci-dessous :
ca416e21-0d37-4bbe-9fbc-0ad6b52b74da
83cd18d0-32ad-47ac-8475-614beb06001a
Ce diagramme illustre un document WordprocessingML contenant deux chapitres, chacun contenant deux tables étiquetées avec des légendes. Le style associé à la démarcation de chapitre a été appliqué aux chaînes : Chapitre 1 - FY02 et Chapitre 2 - FY03 dans ce document. Plus précisément, le style utilisé pour délimiter les chapitres est le style avec son attribut styleID égal à Heading2 tel que spécifié par la valeur d’attribut heading du WordprocessingML pour le format légende :
<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="8212" />
En d’autres termes, le WordprocessingML ci-dessus peut être utilisé pour étiqueter les objets (dans ce cas, les tableaux) insérés dans un document WordprocessingML donné généré par une application avec un légende composé de : la chaîne Table suivie d’un nombre décimal correspondant au numéro de chapitre dans lequel la table est présente, d’un trait d’union et d’une lettre majuscule en anglais correspondant à l’index de la table donnée dans le chapitre donné. Fin de l’exemple]
[Remarque : WordprocessingML est conçu de telle sorte que l’élément légende puisse être utilisé conjointement avec les applications pour fournir une expérience de sous-titrage dynamique. En d’autres termes, une application peut utiliser wordprocessingML dans l’exemple ci-dessus pour insérer automatiquement un légende composé de la chaîne Table suivie d’un champ nombre décimal incrémentiel sous les tables lorsque des tables sont insérées dans un document WordprocessingML tel que défini par l’élément autoCaption (§17.15.1.7). Fin de la remarque]
| Éléments parents |
|---|
| paramètres (§17.15.1.78) |
| Éléments enfants | Paragraphe |
|---|---|
| autoCaptions (paramètres de sous-titrage automatique) | §17.15.1.8 |
| légende (définition de type de légende unique) | §17.15.1.16 |
[Remarque : La définition de schéma XML W3C du modèle de contenu de cet élément (CT_Captions) se trouve dans §A.1. Fin de la remarque]
ISO/IEC29500 : 2008.
Constructeurs
| Captions() |
Initialise une nouvelle instance de la classe Captions. |
| Captions(IEnumerable<OpenXmlElement>) |
Initialise une nouvelle instance de la classe Captions avec les éléments enfants spécifiés. |
| Captions(OpenXmlElement[]) |
Initialise une nouvelle instance de la classe Captions avec les éléments enfants spécifiés. |
| Captions(String) |
Initialise une nouvelle instance de la classe Captions à partir du code XML externe. |
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 actuel. (Hérité de OpenXmlCompositeElement) |
| 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 OpenXmlCompositeElement) |
| InnerText |
Obtient ou définit les valeurs concaténées du nœud actuel et de tous ses enfants. (Hérité de OpenXmlCompositeElement) |
| InnerXml |
Obtient ou définit le balisage qui représente uniquement les nœuds enfants du nœud actuel. (Hérité de OpenXmlCompositeElement) |
| LastChild |
Obtient le dernier enfant de l’élément OpenXmlElement actuel. Retourne null (Nothing en Visual Basic) s’il n’existe aucun élément OpenXmlElement de ce type. (Hérité de OpenXmlCompositeElement) |
| LocalName |
Paramètres de légende. 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 :captions. |
| 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) |
| AddChild(OpenXmlElement, Boolean) |
Ajoute l’élément spécifié à l’élément s’il s’agit d’un enfant connu. Cela ajoute l’élément à l’emplacement approprié en fonction du schéma. (Hérité de OpenXmlCompositeElement) |
| 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 OpenXmlCompositeElement) |
| 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 OpenXmlCompositeElement) |
| 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é des enfants de l’élément actuel. (Hérité de OpenXmlCompositeElement) |
| 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 OpenXmlCompositeElement) |
| 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 nœuds enfants de l’élément actuel. (Hérité de OpenXmlCompositeElement) |
| 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 OpenXmlCompositeElement) |
| 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é. (Hérité de OpenXmlCompositeElement) |
| 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 l’un des éléments enfants de l’élément actuel par un autre élément OpenXmlElement. (Hérité de OpenXmlCompositeElement) |
| 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() |
Paramètres de légende. 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 :captions. (Hérité de OpenXmlElement) |
| IEnumerable<OpenXmlElement>.GetEnumerator() |
Retourne un énumérateur qui itère au sein de la collection enfant. (Hérité de OpenXmlElement) |