Word.TableOfContentsAddOptions interface
Especifica as opções para adicionar a um Word. Objeto TableOfContentsCollection.
Comentários
Conjunto de APIs: WordApiDesktop 1.4
Usada por
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/42-reference-tables/table-of-contents.yaml
// Adds a table of contents at the start of the document.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfContents: Word.TableOfContentsCollection = context.document.tablesOfContents;
const insertionRange: Word.Range = documentBody.getRange(Word.RangeLocation.start);
const tableOptions: Word.TableOfContentsAddOptions = {
includePageNumbers: true,
lowerHeadingLevel: 2,
rightAlignPageNumbers: true,
upperHeadingLevel: 1,
useBuiltInHeadingStyles: true,
};
const tableOfContents: Word.TableOfContents = tablesOfContents.add(insertionRange, tableOptions);
await context.sync();
console.log("Created a table of contents.");
});
Propriedades
| added |
Se fornecido, especifica os nomes de cadeia de caracteres de estilos adicionais a serem usados para o sumário. Use HeadingStyleCollection.add para criar novos estilos de título. |
| hide |
Se fornecido, especifica se os números de página em um sumário devem ser ocultos ao publicar na Web. O valor padrão é |
| include |
Se fornecido, especifica se os números de página devem ser incluídos em um sumário. O valor padrão é |
| lower |
Se fornecido, especifica o nível de título final de um sumário e deve ter um valor de 1 a 9. Deve ser maior que |
| right |
Se fornecido, especifica se os números de página em um sumário estão alinhados com a margem direita. O valor padrão é |
| table |
Se fornecido, especifica um identificador de uma letra dos campos TC que é usado para um sumário. Corresponde à |
| upper |
Se fornecido, especifica o nível de título inicial de um sumário e deve ser um valor de 1 a 9. Deve ser menor que |
| use |
Se fornecido, especifica se os estilos de título internos devem ser usados para criar um sumário. O valor padrão é |
| use |
Se fornecido, especifica se os campos TC (Entrada de Sumário) são usados para criar um sumário. Use o método TableOfContentsCollection.markTocEntry para marcar entradas a serem incluídas em um sumário. O valor padrão é |
| use |
Se fornecido, especifica se as entradas em um sumário devem ser formatadas como hiperlinks quando o documento for publicado na Web. O valor padrão é |
| use |
Se fornecido, especifica se os níveis da estrutura de tópicos devem ser usados para criar um sumário. O valor padrão é |
Detalhes da propriedade
addedStyles
Se fornecido, especifica os nomes de cadeia de caracteres de estilos adicionais a serem usados para o sumário. Use HeadingStyleCollection.add para criar novos estilos de título.
addedStyles?: string;Valor da propriedade
string
Comentários
hidePageNumbersOnWeb
Se fornecido, especifica se os números de página em um sumário devem ser ocultos ao publicar na Web. O valor padrão é true.
hidePageNumbersOnWeb?: boolean;Valor da propriedade
boolean
Comentários
includePageNumbers
Se fornecido, especifica se os números de página devem ser incluídos em um sumário. O valor padrão é true.
includePageNumbers?: boolean;Valor da propriedade
boolean
Comentários
lowerHeadingLevel
Se fornecido, especifica o nível de título final de um sumário e deve ter um valor de 1 a 9. Deve ser maior que upperHeadingLevel. Corresponde ao valor final usado com a \o opção para um campo de sumário (sumário). O valor padrão é 9.
lowerHeadingLevel?: number;Valor da propriedade
number
Comentários
rightAlignPageNumbers
Se fornecido, especifica se os números de página em um sumário estão alinhados com a margem direita. O valor padrão é true.
rightAlignPageNumbers?: boolean;Valor da propriedade
boolean
Comentários
tableId
Se fornecido, especifica um identificador de uma letra dos campos TC que é usado para um sumário. Corresponde à \f opção de um campo de sumário (sumário). Por exemplo, "T" indica que um sumário inclui campos TC que usam o identificador de tabela T. Se esse argumento for omitido, os campos TC não serão usados.
tableId?: string;Valor da propriedade
string
Comentários
upperHeadingLevel
Se fornecido, especifica o nível de título inicial de um sumário e deve ser um valor de 1 a 9. Deve ser menor que lowerHeadingLevel. Corresponde ao valor inicial usado com a \o opção para um campo de sumário. O valor padrão é 1.
upperHeadingLevel?: number;Valor da propriedade
number
Comentários
useBuiltInHeadingStyles
Se fornecido, especifica se os estilos de título internos devem ser usados para criar um sumário. O valor padrão é true.
useBuiltInHeadingStyles?: boolean;Valor da propriedade
boolean
Comentários
useFields
Se fornecido, especifica se os campos TC (Entrada de Sumário) são usados para criar um sumário. Use o método TableOfContentsCollection.markTocEntry para marcar entradas a serem incluídas em um sumário. O valor padrão é false.
useFields?: boolean;Valor da propriedade
boolean
Comentários
useHyperlinksOnWeb
Se fornecido, especifica se as entradas em um sumário devem ser formatadas como hiperlinks quando o documento for publicado na Web. O valor padrão é true.
useHyperlinksOnWeb?: boolean;Valor da propriedade
boolean
Comentários
useOutlineLevels
Se fornecido, especifica se os níveis da estrutura de tópicos devem ser usados para criar um sumário. O valor padrão é false.
useOutlineLevels?: boolean;Valor da propriedade
boolean