Word.TableOfContents class

Obtém os estilos adicionais utilizados para o índice. Os estilos predefinidos "Cabeçalho 1" - "Cabeçalho 9" não estão incluídos nesta coleção.

readonly additionalHeadingStyles: Word.HeadingStyleCollection;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os estilos de cabeçalho incorporados são utilizados para o índice.

areBuiltInHeadingStylesUsed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os campos de Entrada de Índice (TC) estão incluídos no índice.

areFieldsUsed: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se as entradas no índice devem ser formatadas como hiperligações ao publicar na Web.

areHyperlinksUsedOnWeb: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os números de página no índice devem ser ocultados ao publicar na Web.

arePageNumbersHiddenOnWeb: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os números de página estão incluídos no índice.

arePageNumbersIncluded: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica se os números de página estão alinhados com a margem direita no índice.

arePageNumbersRightAligned: boolean;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

context: RequestContext;

Valor da propriedade

Especifica o nível de cabeçalho final para o índice. Tem de ser um valor de 1 a 9 e superior a upperHeadingLevel.

lowerHeadingLevel: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Obtém a parte de um documento que é este índice.

readonly range: Word.Range;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o caráter entre as entradas e os respetivos números de página no índice.

tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica um identificador de uma letra a partir dos campos TC que é utilizado para o índice.

tableId: string;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Especifica o nível de cabeçalho inicial para o índice. Tem de ser um valor de 1 a 9 e inferior a lowerHeadingLevel.

upperHeadingLevel: number;

Valor da propriedade

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Elimina este índice.

delete(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(options?: Word.Interfaces.TableOfContentsLoadOptions): Word.TableOfContents;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNames?: string | string[]): Word.TableOfContents;

Parâmetros

Retornos

Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar context.sync() antes de ler as propriedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Word.TableOfContents;

Parâmetros

Retornos

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.TableOfContentsUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

Retornos

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Word.TableOfContents): void;

Parâmetros

Retornos

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é transmitido para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que lhe é transmitido.) Enquanto o objeto original Word.TableOfContents é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableOfContentsData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Word.Interfaces.TableOfContentsData;

Retornos

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Esta chamada é uma abreviatura de context.trackedObjects.add(thisObject). Se estiver a utilizar este objeto entre .sync chamadas e fora da execução sequencial de um lote ".run" e receber um erro "InvalidObjectPath" ao definir uma propriedade ou invocar um método no objeto, terá de adicionar o objeto à coleção de objetos controlados quando o objeto foi criado pela primeira vez. Se este objeto fizer parte de uma coleção, também deve controlar a coleção principal.

track(): Word.TableOfContents;

Retornos

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Esta chamada é abreviada para context.trackedObjects.remove(thisObject). Ter muitos objetos rastreados desacelera o aplicativo host, por isso, lembre-se de liberar todos os objetos adicionados após usá-los. Terá de chamar context.sync() antes de a libertação da memória ser aplicada.

untrack(): Word.TableOfContents;

Retornos

Atualizações todo o índice.

updatePageNumbers(): void;

Retornos

Comentários

[ Conjunto de API: WordApiDesktop 1.4 ]