Essa opção define que `TOC` deve ser construído a partir dos estilos de título integrados. Em Microsoft Word eles são definidos pelo Título 1 - Título 9. Em Aspose.Words esses estilos são representados pela enumeração StyleIdentifier correspondente. Esta enumeração representa um identificador independente de localidade de um estilo, por exemplo `StyleIdentifier.Heading1` representa o estilo Título 1. Usando isso, a formatação e as propriedades do estilo podem ser recuperadas da coleção Style do documento. A classe Style correspondente pode ser recuperada da coleção `Document.Styles` usando a propriedade indexada do tipo StyleIdentifier.
Qualquer conteúdo formatado com esses estilos será incluído no índice. O nível do título definirá o nível hierárquico correspondente da entrada no TOC. Por exemplo, um parágrafo com estilo Título 1 será tratado como o primeiro nível no `TOC` enquanto um parágrafo com Título 2 será tratado como o próximo nível na hierarquia e assim por diante.
| | **Outline Levels***(\U interruptor)* |Cada parágrafo pode definir um nível de estrutura de tópicos nas opções de parágrafo.
Esta configuração determina qual nível este parágrafo deve ser tratado na hierarquia do documento. Esta é uma prática comumente usada para estruturar facilmente o layout de um documento. Esta hierarquia pode ser visualizada mudando para Outline View em Microsoft Word. Semelhante aos estilos de título, pode haver de 1 a 9 níveis de contorno além do nível "Corpo do texto". Os níveis de estrutura de tópicos 1 a 9 aparecerão no `TOC` no nível correspondente da hierarquiaQualquer conteúdo com um nível de estrutura de tópicos definido no estilo de parágrafo ou diretamente no próprio parágrafo é incluído no sumário. No Aspose.Words, o nível de estrutura de tópicos é representado pela propriedade `ParagraphFormat.OutlineLevel` do nó Parágrafo. O nível de estrutura de tópicos de um estilo de parágrafo é representado da mesma forma pela propriedade `Style.ParagraphFormat`.
```
Observe que os estilos de título integrados, como Título 1, têm um nível de estrutura de tópicos obrigatório definido nas configurações de estilo.
```
| | **Custom Styles***(\T interruptor)* |Essa opção permitirá que estilos personalizados sejam usados ao coletar entradas a serem usadas no sumário. Isso geralmente é usado em conjunto com a opção \O para incluir estilos personalizados junto com estilos de título integrados no sumário.Os parâmetros do switch devem ser colocados entre marcas de fala. Muitos estilos personalizados podem ser incluídos, para cada estilo o nome deve ser especificado seguido por uma vírgula seguida do nível em que o estilo deve aparecer no `TOC`. Outros estilos também são separados por vírgula.Por exemplo
```csharp{ TOC \o "1-3" \t "CustomHeading1, 1, CustomHeading2, 2"}```
usará conteúdo estilizado com CustomHeading1 como conteúdo de nível 1 no `TOC` e CustomHeading2 como nível 2.
| | **Use TC Fields***(\F e \L Chaves)* |Nas versões mais antigas do Microsoft Word, a única forma de construir um `TOC` era utilizando campos TC. Esses campos são inseridos ocultos no documento mesmo quando os códigos dos campos são mostrados. Eles incluem o texto que deve ser exibido na entrada e o `TOC` é construído a partir deles. Esta funcionalidade agora não é usada com muita frequência, mas ainda pode ser útil em algumas ocasiões para incluir entradas no `TOC` que não são recuadas para serem visíveis no documento.Quando inseridos, esses campos aparecem ocultos mesmo quando os códigos dos campos são exibidos. Eles não podem ser vistos sem mostrar conteúdo oculto. Para ver esses campos, Mostrar formatação de parágrafo deve estar selecionado.
Esses campos podem ser inseridos em um documento em qualquer posição como qualquer outro campo e são representados pela enumeração `FieldType.FieldTOCEntry`.A opção \F em um `TOC` é usada para especificar que os campos TC devem ser usados como entradas. A mudança por si só, sem qualquer identificador extra, significa que qualquer campo TC no documento será incluído. Qualquer parâmetro extra, geralmente uma única letra, designará que apenas os campos TC que possuem uma opção \f correspondente serão incluídos no TOC. Por exemplo *
```csharp{ TOC \f t }```
incluirá apenas campos TC, como
```csharp{ TC \f t }```
O campo `TOC` também possui uma chave relacionada, a chave \L especifica que apenas o campo TC com níveis dentro do intervalo especificado são incluídos.
Os próprios campos `TC` também podem ter vários interruptores configurados. Estes são:
- *\F - Explicado acima.*
- *\L - Define em qual nível do `TOC` este campo TC aparecerá. Um `TOC` que utilize esta mesma opção só incluirá este campo TC se estiver dentro do intervalo especificado.*
- _\N - A numeração de páginas para esta entrada `TOC` não é exibida. Um exemplo de código de como inserir campos TC pode ser encontrado na próxima seção.
| ### Switches relacionados à aparência | Trocar | Descrição | | :- | :- | | **Omit Page Numbers***(\N Alternar)* |Essa opção é usada para ocultar números de página para determinados níveis do sumário. Por exemplo, você pode definir
```csharp{TOC \o "1-4" \n "3-4" }```
e os números das páginas nas entradas dos níveis 3 e quatro ficarão ocultos junto com os pontos iniciais (se houver). Para especificar apenas um nível, um intervalo ainda deve ser usado, por exemplo "1-1" excluirá números de página apenas para o primeiro nível.Não fornecer nenhum intervalo de níveis omitirá os números de página de todos os níveis do sumário. Isto é útil para definir ao exportar um documento para HTML ou formato semelhante. Isso ocorre porque os formatos baseados em HTML não possuem nenhum conceito de página e, portanto, não precisam de numeração de página.
| | **Insert As Hyperlinks***(\H Interruptor)* |Essa opção especifica que as entradas `TOC` são inseridas como hiperlinks. Ao visualizar um documento em Microsoft Word, essas entradas ainda aparecerão como texto normal dentro do `TOC`, mas possuem hiperlinks e, portanto, podem ser usadas para navegar até a posição da entrada original no documento usando *Ctrl + Clique com o botão esquerdo* em Microsoft Word. Quando essa opção é incluída, esses links também são preservados em outros formatos. Por exemplo, em formatos baseados em HTML, incluindo EPUB e formatos renderizados como PDF e XPS, estes serão exportados como links funcionais.Sem essa opção definida, o `TOC` em todas essas saídas será exportado como texto simples e não demonstrará esse comportamento. Se um documento for aberto no MS Word, o texto das entradas também não será clicável desta forma, mas os números das páginas ainda poderão ser usados para navegar até a entrada original.
| | **Set Separator Character***(\P Interruptor)* |Essa opção permite que o conteúdo que separa o título da entrada e a numeração da página seja facilmente alterado no sumário. O separador a ser usado deve ser especificado após essa opção e colocado entre marcas de fala.Ao contrário do que está documentado na documentação do Office, apenas um caractere pode ser usado em vez de cinco. Isso se aplica tanto ao MS Word quanto ao Aspose.Words.O uso dessa opção não é recomendado, pois não permite muito controle sobre o que é usado para separar entradas e números de página no sumário. Em vez disso, é recomendado editar o estilo `TOC` apropriado, como `StyleIdentifier.TOC1`, e a partir daí editar o estilo de chamada de detalhe com acesso a membros de fonte específicos, etc. Mais detalhes sobre como fazer isso podem ser encontrados posteriormente neste artigo.
| | **Preserve Tab Entries***(\W Interruptor)* |O uso dessa opção especificará que quaisquer entradas que possuam um caractere de tabulação, por exemplo, um cabeçalho que possua uma tabulação no final da linha, serão retidas como um caractere de tabulação adequado ao preencher o TOC. Isso significa que a função do caractere de tabulação estará presente no `TOC` e pode ser usada para formatar a entrada. Por exemplo, certas entradas podem usar paradas de tabulação e caracteres de tabulação para espaçar uniformemente o texto. Contanto que o nível `TOC` correspondente defina as paradas de tabulação equivalentes, as entradas `TOC` geradas aparecerão com espaçamento semelhante.Na mesma situação, se essa opção não fosse definida, os caracteres de tabulação seriam convertidos em espaços em branco equivalentes a guias não funcionais. A saída não apareceria conforme o esperado.
| | **Preserve New Line Entries***(\X Interruptor)* |Semelhante à opção acima, esta opção especifica que os títulos que abrangem várias linhas (usando caracteres de nova linha e não parágrafos separados) serão preservados como estão no sumário gerado. Por exemplo, um título que deve ser espalhado por várias linhas pode usar o caractere de nova linha (Ctrl + Enter ou `ControlChar.LineBreak`) para separar o conteúdo em linhas diferentes. Com esta opção especificada, a entrada no `TOC` preservará esses novos caracteres de linha conforme mostrado abaixo.Nesta situação, se a opção não estiver definida, os caracteres da nova linha serão convertidos em um único espaço em branco.
| ## Inserir campos TC Você pode inserir um novo campo TC na posição atual do [DocumentBuilder](https://reference.aspose.com/words/python-net/aspose.words/documentbuilder/) chamando o método [DocumentBuilder.insert_field](https://reference.aspose.com/words/python-net/aspose.words/documentbuilder/insert_field/) e especificando o nome do campo como "TC" junto com quaisquer opções necessárias. O exemplo abaixo mostra como inserir um campo `TC` no documento usando [DocumentBuilder](https://reference.aspose.com/words/python-net/aspose.words/documentbuilder/). {{< gist "aspose-words-gists" "e9d8f984dac599756ccb4a64b8c79768" "Examples-DocsExamples-DocsExamples-Programming with Documents-Working with Document-add_content_using_document_builder-InsertTCField.py" >}} ## Modificar um índice A formatação das entradas no `TOC` não utiliza os estilos originais das entradas marcadas, mas cada nível é formatado usando um estilo `TOC` equivalente. Por exemplo, o primeiro nível no `TOC` é formatado com o estilo **TOC1**, o segundo nível é formatado com o estilo **TOC2** e assim por diante. Isso significa que para alterar a aparência do `TOC` esses estilos devem ser modificados. No Aspose.Words, esses estilos são representados pelo [StyleIdentifier.TOC1](https://reference.aspose.com/words/python-net/aspose.words/styleidentifier/#toc1) independente de localidade até o [StyleIdentifier.TOC9](https://reference.aspose.com/words/python-net/aspose.words/styleidentifier/#toc9) e podem ser recuperados da coleção [Document.styles](https://reference.aspose.com/words/python-net/aspose.words/documentbase/styles/) usando esses identificadores. Depois que o estilo apropriado do documento for recuperado, a formatação desse estilo poderá ser modificada. Quaisquer alterações nesses estilos serão refletidas automaticamente nos sumários do documento. O exemplo abaixo altera uma propriedade de formatação usada no estilo `TOC` de primeiro nível. {{< gist "aspose-words-gists" "e9d8f984dac599756ccb4a64b8c79768" "Examples-DocsExamples-DocsExamples-Programming with Documents-Contents Management-working_with_table_of_content-ChangeStyleOfTOCLevel.py" >}} Também é útil observar que qualquer formatação direta de um parágrafo (definida no próprio parágrafo e não no estilo) marcada para ser incluída no `TOC` será copiada na entrada do sumário. Por exemplo, se o estilo Título 1 for usado para marcar conteúdo para `TOC` e este estilo tiver formatação em negrito, enquanto o parágrafo também tiver formatação em itálico aplicada diretamente a ele. A entrada `TOC` resultante não estará em negrito, pois faz parte da formatação do estilo, mas estará em itálico, pois está formatado diretamente no parágrafo. Você também pode controlar a formatação dos separadores usados entre cada entrada e número de página. Por padrão, esta é uma linha pontilhada que é espalhada pela numeração da página usando um caractere de tabulação e uma parada de tabulação à direita alinhada perto da margem direita. Usando a classe [Style](https://reference.aspose.com/words/python-net/aspose.words/style/) recuperada para o nível `TOC` específico que você deseja modificar, você também pode modificar a forma como eles aparecem no documento. Para alterar a forma como isso aparece, primeiro o [Style.paragraph_format](https://reference.aspose.com/words/python-net/aspose.words/style/paragraph_format/) deve ser chamado para recuperar a formatação do parágrafo para o estilo. A partir disso, as paradas de tabulação podem ser recuperadas chamando [ParagraphFormat.tab_stops](https://reference.aspose.com/words/python-net/aspose.words/paragraphformat/tab_stops/) e a parada de tabulação apropriada modificada. Usando esta mesma técnica, a própria guia pode ser movida ou removida completamente. O exemplo abaixo mostra como modificar a posição da parada de tabulação direita em parágrafos relacionados a `TOC`. {{< gist "aspose-words-gists" "e9d8f984dac599756ccb4a64b8c79768" "Examples-DocsExamples-DocsExamples-Programming with Documents-Contents Management-working_with_table_of_content-ChangeTOCTabStops.py" >}} ## Remover um índice do documento Um índice pode ser removido do documento removendo todos os nós encontrados entre os nós [FieldStart](https://reference.aspose.com/words/python-net/aspose.words.fields/fieldstart/) e [FieldEnd](https://reference.aspose.com/words/python-net/aspose.words.fields/fieldend/) do campo `TOC`. O código abaixo demonstra isso. A remoção do campo `TOC` é mais simples do que um campo normal, pois não monitoramos os campos aninhados. Em vez disso, verificamos se o nó [FieldEnd](https://reference.aspose.com/words/python-net/aspose.words.fields/fieldend/) é do tipo [FieldType.FIELD_TOC](https://reference.aspose.com/words/python-net/aspose.words.fields/fieldtype/#field_toc), o que significa que encontramos o final do TOC atual. Esta técnica pode ser usada neste caso sem se preocupar com campos aninhados, pois podemos assumir que qualquer documento formado corretamente não terá nenhum campo `TOC` totalmente aninhado dentro de outro campo `TOC`. Primeiramente os nós [FieldStart](https://reference.aspose.com/words/python-net/aspose.words.fields/fieldstart/) de cada `TOC` são coletados e armazenados. O `TOC` especificado é então enumerado para que todos os nós dentro do campo sejam visitados e armazenados. Os nós são então removidos do documento. A amostra Below code demonstra como remover um `TOC` especificado de um documento. {{< gist "aspose-words-gists" "e9d8f984dac599756ccb4a64b8c79768" "Examples-DocsExamples-DocsExamples-Programming with Documents-Contents Management-remove_content-RemoveTOCFromDocument.py" >}} ## Extrair índice Se você deseja extrair um índice de qualquer documento do Word, o exemplo de código a seguir pode ser usado. ```python doc = aw.Document(docs_base.my_dir + "Table of contents.docx") for field in doc.range.fields : if (field.type == aw.fields.FieldType.FIELD_HYPERLINK) : hyperlink = field.as_field_hyperlink() if (hyperlink.sub_address != None and hyperlink.sub_address.find("_Toc") == 0) : tocItem = field.start.get_ancestor(aw.NodeType.PARAGRAPH).as_paragraph() print(tocItem.to_string(aw.SaveFormat.TEXT).strip()) print("------------------") bm = doc.range.bookmarks.get_by_name(hyperlink.sub_address) pointer = bm.bookmark_start.get_ancestor(aw.NodeType.PARAGRAPH).as_paragraph() print(pointer.to_string(aw.SaveFormat.TEXT)) ```