Classe TablesOfContents (Word VBA)

Uma coleção de objetos TableOfContents que representa os índices de conteúdo em um documento. Para usar uma variável de classe TablesOfContents, ela primeiro precisa ser instanciada por exemplo

Dim tocs as TablesOfContents
Set tocs = ActiveDocument.TablesOfContents

For Each

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

Dim tocsTablesOfContent As TableOfContents
For Each tocsTablesOfContent In ActiveDocument.TablesOfContents
	
Next tocsTablesOfContent

Add

Retorna um objeto TableOfContents que representa um índice analítico adicionado a um documento.

Add (Range, UseHeadingStyles, UpperHeadingLevel, LowerHeadingLevel, UseFields, TableID, RightAlignPageNumbers, IncludePageNumbers, AddedStyles, UseHyperlinks, HidePageNumbersInWeb, UseOutlineLevels)

Set myRange = ActiveDocument.Range(0, 0) 
ActiveDocument.TablesOfContents.Add _ 
 Range:=myRange, _ 
 UseFields:=False, _ 
 UseHeadingStyles:=True, _ 
 LowerHeadingLevel:=3, _ 
 UpperHeadingLevel:=1, _ 
 AddedStyles:="myStyle, yourStyle"

Arguments

O seguinte argumento é necessário

Range (Range) - O intervalo onde você deseja que o sumário apareça. O sumário substituirá o intervalo, se o intervalo não estiver recolhido.

Optional arguments

Os seguintes argumentos são opcionais

UseHeadingStyles (Boolean) - True para usar estilos de título internos para criar o sumário. O valor padrão é True.

UpperHeadingLevel (Long) - O nível de título inicial para o sumário. Corresponde ao valor inicial usado com a opção \o de um campo TOC (Sumário). O valor padrão é 1.

LowerHeadingLevel (Byte) - O nível de título final para o sumário. Corresponde ao valor final usado com a opção \o de um campo de sumário (TOC). O valor padrão é 9.

UseFields (Boolean) - True se os campos de entrada de conteúdo (TC) são usados para criar o sumário. Use o método MarkEntry para marcar entradas a serem incluídos no índice de conteúdo. O valor padrão é False.

TableID (String) - Um identificador de uma letra que é usado para construir um sumário a partir de campos TC. Corresponde à opção \f de um campo TOC (sumário). Por exemplo, "T" constrói um sumário a partir de campos TC usando o identificador de índice T. Se esse argumento for omitido, os campos TC não serão usados.

RightAlignPageNumbers (Boolean) - True se os números de página na tabela sumário são alinhados com a margem direita. O valor padrão é True.

IncludePageNumbers (Boolean) - True para incluir números de página no índice de conteúdo. O valor padrão é True.

AddedStyles (HeadingStyles) - O nome da cadeia de caracteres para estilos adicionais usados para compilar o Sumário (estilos diferentes dos estilos título – 1 título 9). Use o método Add de um objeto HeadingStyles para criar novos estilos de título.

UseHyperlinks (Boolean) - True se as entradas em um sumário deverão ser formatadas como hiperlinks quando o documento estiver sendo publicado na Web. O valor padrão é True.

HidePageNumbersInWeb (Boolean) - True se os números de página em um sumário deverão ser ocultos quando o documento estiver sendo publicado na Web. O valor padrão é True.

UseOutlineLevels (Boolean) - True para usar os níveis de estrutura de tópicos para criar o sumário. O padrão é False.

Count

Retorna um Long que representa o número de índices de conteúdo na coleção. Somente leitura.

Dim lngCount As Long
lngCount = ActiveDocument.TablesOfContents.Count

Format

Retorna ou define a formatação dos sumários no documento especificado. Leitura/gravação WdTocFormat. Os valores de retorno possíveis são wdTOCClassic - Formatação clássica, wdTOCDistinctive - Formatação distinta, wdTOCFancy - Formatação sofisticada, wdTOCFormal - Formatação formal, wdTOCModern - Formatação moderna, wdTOCSimple - Formatação simples, wdTOCTemplate - Formatação modelo.

Documents("Report.doc").TablesOfContents.Format = wdTOCClassic

Item

Retorna um objeto TableOfContents individual em uma coleção.

Item (Index)

Index: O objeto individual a ser retornado. Pode ser um Long que indica a posição ordinal do objeto individual.

Dim tocsTablesOfContent As TableOfContents
Set tocsTablesOfContent = ActiveDocument.TablesOfContents(Index:=1)

MarkEntry

Insere um campo TC entrada de sumário após o intervalo especificado. O método retorna um objeto Field que representa o campo TC.

MarkEntry (Range, Entry, EntryAutoText, TableID, Level)

Dim fldMarkEntry As Field
Set fldMarkEntry = ActiveDocument.TablesOfContents.MarkEntry(Range:=)

Arguments

O seguinte argumento é necessário

Range (Range) - A posição da entrada. O campo TC é inserido após Range.

Optional arguments

Os seguintes argumentos são opcionais

Entry (Table) - O texto que aparece no sumário ou índice de ilustrações. Para indicar uma subentrada, inclua o texto da entrada principal e o texto da subentrada, separados por dois-pontos (:) (por exemplo, "Introdução:O Produto").

EntryAutoText (String) - O nome da entrada de AutoTexto que inclui texto do índice, índice de ilustrações ou sumário (Entry é ignorado).

TableID (String) - Um identificador de uma letra para o índice de ilustrações ou sumário (por exemplo, "i" para uma "ilustração").

Level (Long) - Um nível para a entrada no sumário ou índice de ilustrações.