Word.TableOfFiguresAddOptions interface
Especifica as opções para adicionar a um Word. TableOfFiguresCollection.
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-figures.yaml
// Adds a table of figures at the start of the document.
await Word.run(async (context) => {
const documentBody: Word.Body = context.document.body;
const tablesOfFigures: Word.TableOfFiguresCollection = context.document.tablesOfFigures;
const insertionRange: Word.Range = documentBody.getRange(Word.RangeLocation.start);
const tableOptions: Word.TableOfFiguresAddOptions = {
captionLabel: "Figure",
includeLabel: true,
includePageNumbers: true,
rightAlignPageNumbers: true,
tableId: "F",
useFields: true,
};
const tableOfFigures: Word.TableOfFigures = tablesOfFigures.add(insertionRange, tableOptions);
await context.sync();
console.log("Created a table of figures.");
});
Propriedades
| added |
Se fornecido, especifica os nomes de cadeia de caracteres de estilos adicionais a serem usados para o índice de figuras. |
| caption |
Se fornecido, especifica o rótulo que identifica os itens a serem incluídos em um índice de ilustrações. Corresponde à |
| hide |
Se fornecido, especifica se os números de página no índice de figuras devem ser ocultos ao publicar na Web. O valor padrão é |
| include |
Se fornecido, especifica se o rótulo da legenda e o número da legenda devem ser incluídos em uma tabela de figuras. O valor padrão é |
| include |
Se fornecido, especifica se os números de página estão incluídos em uma tabela de ilustrações. O valor padrão é |
| lower |
Se fornecido, especifica o nível de título final de uma tabela de ilustrações quando |
| right |
Se fornecido, especifica se os números de página com a margem direita devem ser alinhados em uma tabela de ilustrações. O valor padrão é |
| table |
Se fornecido, especifica um identificador de uma letra dos campos TC que é usado para uma tabela de ilustrações. Corresponde à |
| upper |
Se fornecido, especifica o nível de título inicial de uma tabela de ilustrações quando |
| use |
Se fornecido, especifica se os estilos de título internos devem ser usados para criar um índice de ilustrações. O valor padrão é |
| use |
Se fornecido, especifica se os campos TC (Entrada de Sumário) devem ser usados para criar um índice de ilustrações. Use o método TableOfFiguresCollection.markTocEntry para marcar entradas a serem incluídas em uma tabela de figuras. O valor padrão é |
| use |
Se fornecido, especifica se as entradas em um índice de figuras devem ser formatadas como hiperlinks quando o documento é publicado na Web. 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 índice de figuras.
addedStyles?: string;Valor da propriedade
string
Comentários
captionLabel
Se fornecido, especifica o rótulo que identifica os itens a serem incluídos em um índice de ilustrações. Corresponde à \c opção de um campo de sumário (sumário). O valor padrão é "Figura".
captionLabel?: string;Valor da propriedade
string
Comentários
hidePageNumbersOnWeb
Se fornecido, especifica se os números de página no índice de figuras devem ser ocultos ao publicar na Web. O valor padrão é true.
hidePageNumbersOnWeb?: boolean;Valor da propriedade
boolean
Comentários
includeLabel
Se fornecido, especifica se o rótulo da legenda e o número da legenda devem ser incluídos em uma tabela de figuras. O valor padrão é true.
includeLabel?: boolean;Valor da propriedade
boolean
Comentários
includePageNumbers
Se fornecido, especifica se os números de página estão incluídos em uma tabela de ilustrações. 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 uma tabela de ilustrações quando useBuiltInHeadingStyles definido como true. Deve ser um valor de 1 a 9 e 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 com a margem direita devem ser alinhados em uma tabela de ilustrações. 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 uma tabela de ilustrações. Corresponde à \f opção de um campo de sumário (sumário). Por exemplo, "T" indica que uma tabela de imagens inclui campos TC que usam o identificador de tabela T.
tableId?: string;Valor da propriedade
string
Comentários
upperHeadingLevel
Se fornecido, especifica o nível de título inicial de uma tabela de ilustrações quando useBuiltInHeadingStyles definido como true. Deve ser um valor de 1 a 9 e 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 índice de ilustrações. O valor padrão é false.
useBuiltInHeadingStyles?: boolean;Valor da propriedade
boolean
Comentários
useFields
Se fornecido, especifica se os campos TC (Entrada de Sumário) devem ser usados para criar um índice de ilustrações. Use o método TableOfFiguresCollection.markTocEntry para marcar entradas a serem incluídas em uma tabela de figuras. O valor padrão é false.
useFields?: boolean;Valor da propriedade
boolean
Comentários
useHyperlinksOnWeb
Se fornecido, especifica se as entradas em um índice de figuras devem ser formatadas como hiperlinks quando o documento é publicado na Web. O valor padrão é true.
useHyperlinksOnWeb?: boolean;Valor da propriedade
boolean