Cet article a fait l’objet d’une traduction automatique. Pour afficher l’article en anglais, activez la case d’option Anglais. Vous pouvez également afficher le texte anglais dans une fenêtre contextuelle en faisant glisser le pointeur de la souris sur le texte traduit.
Traduction
Anglais

Caption - Classe

Office 2013 et versions ultérieures

Cette documentation est préliminaire et peut changer.

Définition de Type légende unique. Lorsque l'objet est sérialisé en XML, son nom complet est w:caption.

Espace de noms :  DocumentFormat.OpenXml.Wordprocessing
Assembly :  DocumentFormat.OpenXml (dans DocumentFormat.OpenXml.dll)

public class Caption : OpenXmlLeafElement

[ISO/IEC 29500-1 1st Edition]

caption (Single Caption Type Definition)

Cet élément spécifie le contenu et le positionnement de légendes qui peuvent être utilisées pour étiqueter automatiquement les objets dans un document WordprocessingML. Une légende est une chaîne qui nomme un objet inclus dans un document WordprocessingML et est généralement constitué d'une chaîne, ainsi qu'un champ de numéros de cet élément dans une collection d'objets similaires.

[Exemple: examinons le diagramme ci-dessous illustre un document WordprocessingML contenant une table qui a été appelée avec une légende :

Dans ce diagramme, la table contenue dans le document WordprocessingML a été étiquetée en insérant une légende sous le tableau qui se compose de la chaîne de tableau suivie d'un champ dont le résultat est un nombre décimal. Les paramètres automatiquement produit cette forme de légende sont spécifiés à l'aide du fragment de WordprocessingML suivant :

<w:captions>
  <w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />
</w:captions>

L'élément de légende spécifie les paramètres à la légende qui en résulte pour être utilisée pour étiqueter automatiquement contenu dans le document WordprocessingML. En particulier, les attributs nom et numFmt spécifient que des légendes de ce type de légende inséré dans le document WordprocessingML donné sont constitué par la chaîne de tableau suivie d'un incrémentation champ numéro décimal. En outre, l'attribut pos Spécifie que ces légendes doivent être placées au-dessous de l'objet qu'ils sont utilisés pour l'étiquette.

WordprocessingML est conçue pour que l'élément de légende utilisable conjointement avec les applications pour fournir une expérience de sous-titrage dynamique. En d'autres termes, une application peut utiliser le schéma WordprocessingML dans l'exemple ci-dessus pour insérer automatiquement une légende qui se compose de la chaîne de tableau suivie d'un champ numérique décimal incrémentation sous tables lorsque des tables sont insérés dans un document WordprocessingML tel que défini par l'élément de légende automatique (§17.15.1.7). exemple de fin]

Éléments parents

légendes (§17.15.1.17)

Attributs

Description

chapNum (numéro de chapitre inclure dans le champ de légende)

Indique ou non afficher la numérotation associé avec le titre de chapitre la plus récent du document WordprocessingML dans le champ caption. Un titre de chapitre est un paragraphe de texte au sein d'un document WordprocessingML qui est mis en forme avec un style qui a été spécifié par l'attribut de titre pour séparer les chapitres dans les documents.

Qu'un style avec son attribut styleID égal à Titre1, Titre2, Titre3, Titre4, Titre5, Titre6, Titre7, Titre8ou Titre9 peut être spécifié comme le style utilisé pour séparer les chapitres dans un document. Le choix de ces des niveaux de titre doit servir à déterminer que le numéro de chapitre actuel est défini par la valeur de l'attribut de titre correspondant. [Exemple: Titre1 est utilisé comme titre de chapitre lorsque chapNum a la valeur true et l'en-tête est 1. exemple de fin]

Si cet attribut est omis, les numéros de chapitre ne sont pas inclus dans la légende qui en résulte.

[Exemple: examinons le diagramme ci-dessous :

Ce schéma représente un document WordprocessingML contenant deux chapitres, chacun contenant deux tables avec des légendes. Le style Titre 2 a été associé aux titres de chapitre et appliqué aux chaînes : chapitre 1 - EC02 et chapitre 2 - FY03 dans ce document.

Plus précisément, le style utilisé pour séparer les chapitres, est le style avec un attribut styleID égal à Titre2 tel que spécifié par la valeur de l'attribut titre du schéma WordprocessingML pour cette légende, définie comme suit :

<w:caption w:name="Table" w:pos="below" w:chapNum="true" w:heading="2" w:numFmt="upperLetter" w:sep="8212" /> 

L'attribut chapNum a la valeur true, indiquant que les légendes utilisées pour étiqueter les tables au sein de ce document contient un symbole correspondant à l'index de base 1 du chapitre dans laquelle il se trouve.

Ceci peut être observé dans la mesure où les légendes dans le chapitre 1 contient 1, tandis que les légendes dans le chapitre 2 contiennent un 2, correspondant chacune à leur numéro de chapitre respectifs. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_OnOff (§22.9.2.7).

titre (Style des titres de chapitre)

Spécifie le style donné qui est utilisé pour séparer les titres de chapitre dans un document.

Cette valeur est utilisée pour lier les titres des chapitres avec des paragraphes avec un attribut styleID comme suit :

Valeur

Description

Style avec styleID de Titre1

Style avec styleID de Titre2

Style avec styleID de Titre3

Style avec styleID de Titre4

Style avec styleID de Titre5

Style avec styleID de Titre6

Style avec styleID de Titre7

Style avec styleID de Titre8

Style avec styleID de Titre9

Toute autre valeur

Défini par l'application. Peut être ignoré.

Si cet attribut est omis, sa valeur doit être supposée est 1.

[Exemple: examinons le diagramme ci-dessous :

Ce schéma représente un document WordprocessingML contenant deux chapitres, chacun contenant deux tables avec des légendes. Le style Titre 2 a été associé aux titres de chapitre et appliqué aux chaînes : chapitre 1 - EC02 et chapitre 2 - FY03 dans ce document.

Plus précisément, le style utilisé pour séparer les titres de chapitre est le style avec son attribut styleID égal à titre« comme spécifié par la valeur de l'attribut titre du schéma WordprocessingML ci-dessous.

<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 schéma WordprocessingML ci-dessus peut être utilisé pour étiqueter des tableaux insérés dans un document WordprocessingML donné généré par une application avec une légende qui se compose de : la chaîne Table suivie d'un nombre décimal correspondant avec le numéro du chapitre dans laquelle la table est présente, un tiret, comme défini dans l'attribut sep, et une lettre majuscule anglaise défini par l'attribut numFmt correspondant à la table donnée classement dans le chapitre en cours. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_DecimalNumber (§17.18.10).

nom (nom du Type de légende)

Spécifie le composant de chaîne littérale de cette légende.

Cette valeur est utilisée comme suit :

  • Il est ajouté dans le champ contenant le numéro de chapitre et le numéro d'article de cet objet lorsqu'une légende est automatiquement ajoutée au document.

  • Il est utilisé pour étiqueter de manière unique ce type de légende, ce qui lui permet d'être liée avec les classes d'objets via l'élément de légende automatique (§17.15.1.7)

  • Elle peut être utilisée pour étiqueter ce type de légende dans une interface utilisateur.

[Exemple: examinons le diagramme ci-dessous illustre un document WordprocessingML contenant une table qui a été appelée avec une légende :

Dans ce diagramme, la table contenue dans le document WordprocessingML a été étiquetée en insérant une légende sous le tableau qui se compose de la chaîne de tableau suivie d'un nombre décimal. Ce format de légende est spécifié avec le schéma WordprocessingML suivant :

<w:caption w:name="Table" w:pos="below" w:numFmt="decimal" />

En particulier, l'attribut name spécifie que la première partie de la chaîne qui comprend la légende donnent est composé de la Tablede la chaîne. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_String (§22.9.2.13).

noLabel (effectuez pas inclure nom de légende)

Spécifie si la chaîne spécifiée dans l'attribut nom doit figurer dans la légende qui en résulte lorsqu'il est automatiquement ajouté au document. Si la valeur true, puis le texte de l'étiquette dans l'attribut name est omise lors de l'ajout de la légende.

Si cet attribut est omis, le nom doit être ajouté à la légende.

[Exemple: examinons le diagramme ci-dessous illustre un document WordprocessingML contenant une table qui a été appelée avec une légende :

Dans ce diagramme, la table contenue dans le document WordprocessingML a été étiquetée en insérant une légende sous le tableau composé d'un nombre décimal.

Ce format de légende est spécifié en utilisant le schéma WordprocessingML suivant :

<w:caption w:name="Custom" w:pos="below" w:noLabel="true" w:numFmt="decimal" /> 

Dans ce cas, l'attribut noLabel est égale à true spécifiant que lorsque ce format de légende est automatiquement ajouté, il ne doit pas inclure l'étiquette. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_OnOff (§22.9.2.7).

numFmt (Format de numérotation de légende)

Spécifie le format de la numérotation qui doivent figurer dans une légende générée automatiquement pour spécifier l'index de cet élément de la collection (dans le chapitre en cours si chapNum est spécifié, ou dans l'histoire du document en cours).

Si cet attribut est omis, sa valeur par défaut doit être supposée être decimal.

[Exemple: examinons le diagramme ci-dessous illustre un document WordprocessingML contenant une table qui a été appelée avec une légende :

Dans cet exemple, la table contenue dans le document WordprocessingML a été étiquetée en insérant une légende sous le tableau composé d'un nombre décimal.

Ce format de légende est spécifié en utilisant le schéma WordprocessingML suivant :

<w:caption w:name="Custom" w:pos="below" w:noLabel="true" w:numFmt="decimal" /> 

Dans ce cas, l'attribut numFmt est égal à décimale, spécifiant qu'un nombre décimal doit figurer dans la légende du tableau lorsqu'il est inséré automatiquement. Exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_NumberFormat (§17.18.59).

POS (Placement Légende automatique)

Spécifie comment une légende automatiquement insérée doit être positionnée par rapport à l'objet qu'il est le sous-titrage.

Si cet attribut est omis, la valeur par défaut doit être inférieure.

[Exemple: examinons le diagramme ci-dessous illustre un document WordprocessingML contenant une table qui a été appelée avec une légende.

Dans ce diagramme, la table contenue dans le document WordprocessingML a été étiquetée en insérant une légende sous le tableau qui se compose de la chaîne de tableau suivie d'un nombre décimal.

Ce format de légende est spécifié en utilisant le schéma WordprocessingML suivant :

<w:caption w:name="Table" w:pos="below" w:numFmt="decimal" /> 

L'attribut pos Spécifie que la légende donnée doit être placée ci-dessous l'objet qu'il est étiquetage. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_CaptionPos (§17.18.5).

SEP (chapitre article/Index séparateur)

Spécifie le caractère qui doit être utilisé pour séparer le numéro de chapitre utilisé dans cette légende de la numérotation de l'élément de légende. Un format de légende se compose de trois composants :

  • La chaîne littérale (facultative)

  • Le numéro de chapitre (facultatif)

  • L'index de cette légende dans le chapitre/document

Lorsque les deux éléments de cette dernière sont toutes deux présentes, ils sont délimités en utilisant le séparateur de chapitre spécifié par cet attribut.

Si cet attribut est omis, sa valeur par défaut est un trait d'union. Si le numéro de chapitre n'est pas partie de la forme Légende, ce paramètre est ignoré.

[Exemple: examinons le diagramme ci-dessous :

Ce schéma représente un document WordprocessingML contenant deux chapitres, chacun contenant deux tables avec des légendes. Le style Titre 2 a été associé aux titres de chapitre et appliqué aux chaînes : chapitre 1 - EC02 et chapitre 2 - FY03 dans ce document.

Plus précisément, le style utilisé pour séparer les titres de chapitre est le style avec un attribut styleID égal à Titre2 tel que spécifié par la valeur de l'attribut titre du schéma WordprocessingML ci-dessous.

<w:caption w:name="Table" w:pos="below" w:chapNum="1" w:heading="2" w:numFmt="upperLetter" w:sep="hyphen" />

La valeur de l'attribut sep du trait d'union indique que le nombre et la légende un index de chapitres doit être séparé par un caractère de trait d'union, lorsqu'il est affiché dans le document. exemple de fin]

Les valeurs possibles pour cet attribut sont définies par le type simple ST_ChapterSep (§17.18.6).

[Remarque: le W3C XML Schema definition de cet élément modèle de contenu (CT_Caption) se trouve dans §A.1. fin de la Remarque]

© ISO/IEC29500: 2008.

Tous les membres statique (Partagé dans Visual Basic)s publics de ce type sont thread-safe. Cela n’est pas garanti pour les membres d’instance.
Afficher: