Word.TableOfContents class
Representa um índice num Word documento.
- Extends
Propriedades
| additional |
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. |
| are |
Especifica se os estilos de cabeçalho incorporados são utilizados para o índice. |
| are |
Especifica se os campos de Entrada de Índice (TC) estão incluídos no índice. |
| are |
Especifica se as entradas no índice devem ser formatadas como hiperligações ao publicar na Web. |
| are |
Especifica se os números de página no índice devem ser ocultados ao publicar na Web. |
| are |
Especifica se os números de página estão incluídos no índice. |
| are |
Especifica se os números de página estão alinhados com a margem direita no índice. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| lower |
Especifica o nível de cabeçalho final para o índice. Tem de ser um valor de 1 a 9 e superior a |
| range | Obtém a parte de um documento que é este índice. |
| tab |
Especifica o caráter entre as entradas e os respetivos números de página no índice. |
| table |
Especifica um identificador de uma letra a partir dos campos TC que é utilizado para o índice. |
| upper |
Especifica o nível de cabeçalho inicial para o índice. Tem de ser um valor de 1 a 9 e inferior a |
Métodos
| delete() | Elimina este índice. |
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| set(properties, options) | 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) | Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente. |
| toJSON() | Substitui o método JavaScript |
| track() | 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 |
| untrack() | 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 |
| update |
Atualizações todo o índice. |
Detalhes da propriedade
additionalHeadingStyles
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
areBuiltInHeadingStylesUsed
Especifica se os estilos de cabeçalho incorporados são utilizados para o índice.
areBuiltInHeadingStylesUsed: boolean;Valor da propriedade
boolean
Comentários
areFieldsUsed
Especifica se os campos de Entrada de Índice (TC) estão incluídos no índice.
areFieldsUsed: boolean;Valor da propriedade
boolean
Comentários
areHyperlinksUsedOnWeb
Especifica se as entradas no índice devem ser formatadas como hiperligações ao publicar na Web.
areHyperlinksUsedOnWeb: boolean;Valor da propriedade
boolean
Comentários
arePageNumbersHiddenOnWeb
Especifica se os números de página no índice devem ser ocultados ao publicar na Web.
arePageNumbersHiddenOnWeb: boolean;Valor da propriedade
boolean
Comentários
arePageNumbersIncluded
Especifica se os números de página estão incluídos no índice.
arePageNumbersIncluded: boolean;Valor da propriedade
boolean
Comentários
arePageNumbersRightAligned
Especifica se os números de página estão alinhados com a margem direita no índice.
arePageNumbersRightAligned: boolean;Valor da propriedade
boolean
Comentários
context
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
lowerHeadingLevel
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
number
Comentários
range
Obtém a parte de um documento que é este índice.
readonly range: Word.Range;Valor da propriedade
Comentários
tabLeader
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
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Comentários
tableId
Especifica um identificador de uma letra a partir dos campos TC que é utilizado para o índice.
tableId: string;Valor da propriedade
string
Comentários
upperHeadingLevel
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
number
Comentários
Detalhes do método
delete()
load(options)
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
Fornece opções para as propriedades do objeto a carregar.
Retornos
load(propertyNames)
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
- propertyNames
-
string | string[]
Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.
Retornos
load(propertyNamesAndPaths)
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
- propertyNamesAndPaths
-
{ select?: string; expand?: string; }
propertyNamesAndPaths.select é uma cadeia delimitada por vírgulas que especifica as propriedades a carregar e propertyNamesAndPaths.expand é uma cadeia delimitada por vírgulas que especifica as propriedades de navegação a carregar.
Retornos
set(properties, options)
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
- properties
- Word.Interfaces.TableOfContentsUpdateData
Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.
- options
- OfficeExtension.UpdateOptions
Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.
Retornos
void
set(properties)
Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
set(properties: Word.TableOfContents): void;Parâmetros
- properties
- Word.TableOfContents
Retornos
void
toJSON()
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
track()
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
untrack()
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
updatePageNumbers()
Atualizações todo o índice.
updatePageNumbers(): void;Retornos
void