Classe TablesOfFigures (Word VBA)

Uma coleção de objetos TableOfFigures que representa os índices de ilustrações em um documento. Para usar uma variável de classe TablesOfFigures, ela primeiro precisa ser instanciada por exemplo

Dim tofs as TablesOfFigures
Set tofs = ActiveDocument.TablesOfFigures

For Each

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

Dim tofsTablesOfFigure As TableOfFigures
For Each tofsTablesOfFigure In ActiveDocument.TablesOfFigures
	
Next tofsTablesOfFigure

Add

Retorna um objeto TableOfFigures que representa um índice de ilustrações adicionado a um documento.

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

ActiveDocument.TablesOfFigures.Add Range:=Selection.Range

Arguments

O seguinte argumento é necessário

Range (Range) - O intervalo onde você deseja que o índice de ilustrações apareça.

Optional arguments

Os seguintes argumentos são opcionais

Caption (String) - O rótulo que identifica os itens que você deseja incluir no índice de ilustrações. Corresponde à opção \c de um campo TOC (sumário). O valor padrão é "Figure".

IncludeLabel (String) - True para incluir o nome da legenda e o número da legenda no índice de ilustrações. O valor padrão é True.

UseHeadingStyles (Boolean) - True para usar estilos de título internos para criar o índice de ilustrações. O valor padrão é False.

UpperHeadingLevel (Long) - O nível de título inicial para o índice de ilustrações, se UseHeadingStyles estiver definido como true. Corresponde ao valor inicial usado com a opção \o de um campo TOC (índice analítico). O valor padrão é 1.

LowerHeadingLevel (Byte) - O nível de título final para o índice de ilustrações, se UseHeadingStyles estiver definido como true. Corresponde ao valor final usado com a opção \o de um campo TOC (índice analítico). O valor padrão é 9.

UseFields (Boolean) - True para usar os campos de entrada de conteúdo (TC) para criar o índice de ilustrações. Use o método MarkEntry para marcar as entradas que você deseja incluir no índice de ilustrações. O valor padrão é False.

TableID (String) - Um identificador de uma letra que é usado para construir um índice de ilustrações a partir de campos TC (entrada de sumário). Corresponde à opção \f de um campo TOC (sumário). Por exemplo, "i" constrói um índice de ilustrações para uma ilustração.

RightAlignPageNumbers (Boolean) - True alinha números de página com a margem direita da tabela de figuras. O valor padrão é True.

IncludePageNumbers (Boolean) - True se os números de página são incluídos no índice de ilustrações. O valor padrão é True.

AddedStyles (String) - O nome da cadeia de caracteres para estilos adicionais usados para compilar o índice de ilustrações (estilos diferentes – dos estilos título 1 título 9).

UseHyperlinks (Boolean) - True se as entradas em um índice de ilustrações devem ser formatadas como hiperlinks ao publicar na Web. O valor padrão é True.

HidePageNumbersInWeb (Boolean) - True se os números de página em um índice de ilustrações devem ficar ocultos ao publicar na Web. O valor padrão é True.

Count

Retorna um Long que representa o número de índices de ilustrações na coleção. Somente leitura.

Dim lngCount As Long
lngCount = ActiveDocument.TablesOfFigures.Count

Format

Retorna ou define a formatação para os índices de ilustrações no documento especificado. Leitura/gravação WdTofFormat. Os valores de retorno possíveis são wdTOFCentered - Formatação centralizada, wdTOFClassic - Formatação clássica, wdTOFDistinctive - Formatação distinta, wdTOFFormal - Formatação formal, wdTOFSimple - Formatação simples, wdTOFTemplate - Formatação modelo.

ActiveDocument.TablesOfFigures.Format = wdTOFCentered

Item

Retorna um objeto TableOfFigures 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 tofsTablesOfFigure As TableOfFigures
Set tofsTablesOfFigure = ActiveDocument.TablesOfFigures(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.TablesOfFigures.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.