Classe CaptionLabel - nome de legenda (Word VBA)

A classe CaptionLabel representa um único nome de legenda. O objeto CaptionLabel é um membro do CaptionLabels coleção. Os itens da coleção CaptionLabels são listados na caixa rótulo na caixa de diálogo de legenda. Para usar uma variável de classe CaptionLabel, ela primeiro precisa ser instanciada por exemplo


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

For Each

Aqui está um exemplo de processamento dos itens CaptionLabel em uma coleção.


Dim cll As CaptionLabel
For Each cll In CaptionLabels
	
Next cll

BuiltIn

True se o nome da legenda especificado é um dos rótulos de legenda internos no Word. Boolean somente leitura.

Você pode especificar estilos internos em todos os idiomas usando as constantes WdBuiltinStyle ou dentro de um idioma usando o nome do estilo para a versão de idioma do Word. Por exemplo, se você especificar o inglês dos EUA em suas configurações de idioma do Microsoft Office, as instruções a seguir são equivalentes:


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

ChapterStyleLevel

Retorna ou define o estilo de título que marca um novo capítulo quando os números de capítulo são incluídos com o rótulo de legenda especificado. Long de leitura/gravação.

O número 1 corresponde a Heading 1, 2 corresponde ao título 2 e assim por diante. A propriedade IncludeChapterNumber deve ser definida como True para números de capítulo sejam incluídos com nomes de legenda.


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

Delete

Exclui o rótulo de legenda especificado.


CaptionLabels(1).Delete

ID

Retorna uma constante WdCaptionLabelID que representa o tipo do nome de legenda especificado se a propriedade BuiltIn do objeto CaptionLabel for true. Somente leitura. Os valores de retorno possíveis são wdCaptionEquation - Subscrito, wdCaptionFigure - Configura, wdCaptionTable - Configurável.


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

IncludeChapterNumber

True se um número de capítulo é incluído com números de página ou um nome de legenda. Boolean de leitura/gravação.


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

Name

Retorna o nome do objeto especificado. Cadeia de caracteressomente leitura.


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

NumberStyle

Retorna ou define o estilo de número para o objeto CaptionLabel. Leitura/gravação WdCaptionNumberStyle. Aqui você pode encontrar os valores possíveis para WdCaptionNumberStyle.

Algumas constantes listadas acima podem não estar disponíveis para você, dependendo do suporte a idioma (por exemplo, português do Brasil) que tiver sido selecionado ou instalado.


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

Position

Retorna ou define a posição do texto do rótulo de legenda. Leitura/gravação WdCaptionPosition. Os valores de retorno possíveis são wdCaptionPositionAbove - O nome da legenda é adicionado acima, wdCaptionPositionBelow - O nome da legenda é adicionado abaixo.


CaptionLabels(1).Position = wdCaptionPositionAbove

Separator

Retorna ou define o caractere entre o número do capítulo e o número de sequência. Leitura/gravação WdSeparatorType. Os valores de retorno possíveis são wdSeparatorColon - Dois-pontos, wdSeparatorEmDash - Um travessão enfatizado, wdSeparatorEnDash - Um travessão padrão, wdSeparatorHyphen - Um hífen, wdSeparatorPeriod - Um ponto-final.


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