Classe Indexes (Word VBA)

Uma coleção de objetos index que representa todos os índices no documento especificado. Para usar uma variável de classe Indexes, ela primeiro precisa ser instanciada por exemplo


Dim idxs as Indexes
Set idxs = ActiveDocument.Indexes

For Each

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


Dim idx As Index
For Each idx In ActiveDocument.Indexes
	
Next idx

Add

Retorna um objeto Index que representa um novo índice adicionado a um documento.

Um índice é construído a partir de campos de entrada de índice (XE) em um documento. Use o método MarkEntry para marcar entradas de índice a serem incluídos em um índice.

Add (Range, HeadingSeparator, RightAlignPageNumbers, Type, NumberOfColumns, AccentedLetters, SortBy, IndexLanguage)


ActiveDocument.Indexes.MarkEntry _ 
 Range:=Selection.Range, Entry:="My Entry" 
Set MyRange = ActiveDocument.Content 
MyRange.Collapse Direction:=wdCollapseEnd 
ActiveDocument.Indexes.Add Range:=MyRange, Type:=wdIndexRunin

Arguments

O seguinte argumento é necessário

Range (Range) - O intervalo no qual você deseja que o índice apareça. O índice substituirá o intervalo, se ele não estiver recolhido.

Optional arguments

Os seguintes argumentos são opcionais

HeadingSeparator (String) - O texto entre grupos alfabéticos (entradas que começam com a mesma letra) no índice. Pode ser uma das seguintes constantes WdHeadingSeparator.

RightAlignPageNumbers (Boolean) - True para alinhar os números de página com a margem direita.

Type (WdIndexType) - Especifica se subentradas ficam na mesma linha (' entrada rápida ') da entrada principal ou em uma linha separada (recuado) da entrada principal. Pode ser uma das seguintes constantes WdIndexType : wdIndexIndent ou wdIndexRunin.

Os valores de retorno possíveis são wdIndexIndent - Um índice com recuo, wdIndexRunin - Um índice na mesma linha.

NumberOfColumns (Long) - O número de colunas para cada página no índice. A especificação de 0 (zero) define o número de colunas no índice como o mesmo número que no documento.

AccentedLetters (Boolean) - True para incluir títulos separados para letras acentuadas no índice (por exemplo, palavras que começam com "2 _" e palavras que começam com "A" são listadas sob títulos diferentes).

SortBy (WdIndexSortBy) - Os critérios de classificação a ser usado para o índice especificado. Pode ser uma das seguintes constantes WdIndexSortBy : wdIndexSortByStroke ou wdIndexSortBySyllable.

Os valores de retorno possíveis são wdIndexSortByStroke - Classifica pelo número de pressionamentos em um caractere, wdIndexSortBySyllable - Classificar foneticamente.

IndexLanguage (WdLanguageID) - O idioma de classificação a ser usado para o índice especificado. Pode ser qualquer uma das constantes WdLanguageID. Para a lista de constantes de WdLanguageID válidas, consulte o Pesquisador de objetos no Editor do Visual Basic.

Aqui você pode encontrar os valores possíveis para WdLanguageID

AutoMarkEntries

Adiciona automaticamente campos XE entrada de índice ao documento especificado, usando as entradas de um arquivo de concordância.

Um arquivo de concordância é um documento do Word que contém uma tabela de duas colunas, com termos a serem indexados na primeira coluna e entradas de índice na segunda coluna.

AutoMarkEntries (ConcordanceFileName)

ConcordanceFileName: O nome do arquivo de concordância que inclui uma lista de itens a serem indexados.


Documents("Thesis.doc").Indexes.AutoMarkEntries _ 
 ConcordanceFileName:="C:\Documents\List.doc"

Count

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


Dim lngCount As Long
lngCount = ActiveDocument.Indexes.Count

Format

Retorna ou define um WdIndexFormat que representa a formatação para os índices no documento especificado. Leitura/gravação. Os valores de retorno possíveis são wdIndexBulleted - Com marcadores, wdIndexClassic - Clássica, wdIndexFancy - Sofisticada, wdIndexFormal - Formal.Formal, wdIndexModern - Moderna, wdIndexSimple - Simples, wdIndexTemplate - Do modelo.


ActiveDocument.Indexes.Format = wdIndexBulleted

Item

Retorna um objeto index 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 idx As Index
Set idx = ActiveDocument.Indexes(Index:=1)

MarkAllEntries

Insere um campo XE entrada de índice após todas as ocorrências do texto no intervalo.

MarkAllEntries (Range, Entry, EntryAutoText, CrossReference, CrossReferenceAutoText, BookmarkName, Bold, Italic)


If Selection.Type = wdSelectionNormal Then 
 ActiveDocument.Indexes.MarkAllEntries _ 
 Range:=Selection.Range, _ 
 Entry:=Selection.Range.Text, Italic:=True 
 ActiveDocument.Indexes(1).Update 
End If

Arguments

O seguinte argumento é necessário

Range (Range) - O intervalo cujo texto é marcado com um campo XE ao longo do documento.

Optional arguments

Os seguintes argumentos são opcionais

Entry (Index) - O texto que você deseja que apareça no índice, na forma EntradaPrincipal[:Sub-entrada].

EntryAutoText (String) - A entrada de AutoTexto que contém o texto que você deseja que apareça no índice (se esse argumento for especificado, Entry será ignorado).

CrossReference (Index) - Uma referência cruzada que aparecerá no índice.

CrossReferenceAutoText (String) - O nome da entrada de AutoTexto que contém o texto de uma referência cruzada (se esse argumento for especificado, CrossReference será ignorado).

BookmarkName (String) - O nome do indicador que marca o intervalo de páginas que você deseja que apareça no índice. Se esse argumento for omitido, o número da página que contém o campo XE aparecerá no índice.

Bold (Boolean) - True para adicionar formatação com negrito aos números de página das entradas de índice.

Italic (Boolean) - True para adicionar formatação com itálico aos números de página das entradas de índice.

MarkEntry

Insere um campo XE entrada de índice após o intervalo especificado. O método retorna um objeto Field que representa o campo xe.

MarkEntry (Range, Entry, EntryAutoText, CrossReference, CrossReferenceAutoText, BookmarkName, Bold, Italic, Reading)


If Selection.Type = wdSelectionNormal Then 
 ActiveDocument.Indexes.MarkEntry Range:=Selection.Range, _ 
 Entry:="Introduction:" & Selection.Range.Text, Italic:=True 
End If

Arguments

O seguinte argumento é necessário

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

Optional arguments

Os seguintes argumentos são opcionais

Entry (String) - O texto que aparece no índice. 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).

CrossReference (String) - Uma referência cruzada que aparecerá no índice (por exemplo, "Consulte Maçãs").

CrossReferenceAutoText (String) - O nome de entrada do AutoTexto que contém o texto para uma referência cruzada (CrossReference é ignorado).

Bold (Boolean) - True para adicionar formatação com negrito aos números de página da entrada no índice.

Italic (Boolean) - True para adicionar formatação com itálico aos números de página da entrada no índice.

Reading (Boolean) - True mostra uma entrada de índice no local correto, quando os índices são classificados foneticamente (somente para idiomas do Leste Asiático).