Classe CaptionLabel - étiquette de légende (Word VBA)

Cet objet représente une étiquette de légende donnée.

Pour utiliser une variable de classe CaptionLabel, elle doit d'abord être instanciée, par exemple

Dim cll as CaptionLabel
Set cll = CaptionLabels(Index:=1)

Les procédures suivantes peuvent être utilisés pour définir des variables de la classe CaptionLabel : CaptionLabels.Add et CaptionLabels.Item.

For Each

Voici un exemple de traitement des éléments CaptionLabel dans une collection

Dim cll As CaptionLabel
For Each cll In CaptionLabels
	
Next cll

BuiltIn

True si l'étiquette de légende spécifiée est une des étiquettes de légende prédéfinies dans Word.

Vous pouvez spécifier des styles prédéfinis pour toutes les langues à l'aide de l'une des constantes WdBuiltinStyle ou bien pour une langue en utilisant le nom de style pour la version linguistique de Word.

ActiveDocument.Styles(wdStyleHeading1) 
ActiveDocument.Styles("Heading 1")

ChapterStyleLevel

Cette propriété renvoie ou définit le style de titre qui marque un nouveau chapitre lorsque les numéros de chapitre sont inclus dans l'étiquette de légende.

Le chiffre 1 correspond à Heading 1, 2 correspond à titre 2 et ainsi de suite.

With CaptionLabels(wdCaptionTable) 
 .IncludeChapterNumber = True 
 .ChapterStyleLevel = 2 
End With

Delete

Supprime l’intitulé de légende spécifié.

CaptionLabels(1).Delete

ID

Renvoie une constante WdCaptionLabelID qui représente le type de l’étiquette de légende spécifiée si la propriété BuiltIn de l’objet CaptionLabel a la valeur true. Les valeurs de retour possibles sont wdCaptionEquation - Équation, wdCaptionFigure - Comprendre, wdCaptionTable - Tabulaire.

For Each cl In CaptionLabels 
 If cl.BuiltIn = True Then MsgBox cl.Name & " " & cl.ID 
Next cl

IncludeChapterNumber

True si un numéro de chapitre est ajouté aux numéros de page ou une étiquette de légende.

With CaptionLabels(wdCaptionFigure) 
 .IncludeChapterNumber = True 
 .ChapterStyleLevel = 2 
 .NumberStyle = wdCaptionNumberStyleUppercaseLetter 
End With 
Selection.InsertCaption Label:="Figure", Title:=": History"

Name

Renvoie le nom de l'objet spécifié.

Dim strName As String
strName = CaptionLabels(1).Name

NumberStyle

Cette propriété renvoie ou définit le style de numérotation de l'objet CaptionLabel. Ici on trouve valeurs possible pour WdCaptionNumberStyle.

Il se peut que certaines des constantes énumérées ci-dessus ne soient pas disponibles, selon la prise en charge de langue (anglais (États-Unis), par exemple) que vous avez sélectionnée ou installée.

CaptionLabels(wdCaptionFigure).NumberStyle = _ 
 wdCaptionNumberStyleUppercaseLetter 
Selection.Collapse Direction:=wdCollapseEnd 
Selection.InsertCaption Label:=wdCaptionFigure

Position

Cette propriété renvoie ou définit la position du texte d'étiquette de légende. Les valeurs de retour possibles sont wdCaptionPositionAbove - L'étiquette de légende est placée dans la partie supérieure, wdCaptionPositionBelow - L'étiquette de légende est placée dans la partie inférieure.

CaptionLabels(1).Position = wdCaptionPositionAbove

Separator

Cette propriété renvoie ou définit le caractère situé entre le numéro de chapitre et le numéro de séquence. Les valeurs de retour possibles sont wdSeparatorColon - Deux-points, wdSeparatorEmDash - Tiret long, wdSeparatorEnDash - Tiret standard, wdSeparatorHyphen - Trait d'union, wdSeparatorPeriod - Point.

With CaptionLabels("Figure") 
 .Separator = wdSeparatorColon 
 .IncludeChapterNumber = True 
End With 
Selection.InsertCaption "Figure"