Word.TableOfAuthorities class
Representa um índice de autoridades num documento Word.
- Extends
Comentários
Propriedades
| bookmark | Especifica o nome do marcador a partir do qual são recolhidas entradas de índice de autoridades. |
| category | Especifica a categoria de entradas a incluir no índice de autoridades. Os valores de 0 a 16 correspondem aos itens listados na caixa Categoria da caixa de diálogo Índice de Autoridades. Para saber como aceder a isto através da IU Word, veja Criar um índice de autoridades. |
| context | O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office. |
| entry |
Especifica um separador de até cinco carateres. Isto aparece entre a entrada da tabela de autoridades e o respetivo número de página. |
| is |
Especifica se o nome da categoria de um grupo de entradas aparece no índice de autoridades. |
| is |
Especifica se as entradas no índice de autoridades são apresentadas com a respetiva formatação na tabela. |
| is |
Especifica se as referências à mesma autoridade repetidas em cinco ou mais páginas são substituídas por "Passim". |
| page |
Especifica um separador de até cinco carateres. Isto aparece entre referências de página individuais no índice de autoridades. |
| page |
Especifica um separador de até cinco carateres. Isto aparece entre intervalos de páginas no índice de autoridades. |
| range | Obtém a parte de um documento que é esta tabela de autoridades. |
| sequence |
Especifica o identificador de campo Sequência (SEQ) para o índice de autoridades. |
| sequence |
Especifica um separador de até cinco carateres. Isto aparece entre o número de sequência e o número de página no índice de autoridades. |
| tab |
Especifica o caráter de preenchimento que aparece entre as entradas e os respetivos números de página associados no índice de autoridades. |
Métodos
| delete() | Elimina este índice de autoridades. |
| 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 |
Detalhes da propriedade
bookmark
Especifica o nome do marcador a partir do qual são recolhidas entradas de índice de autoridades.
bookmark: string;
Valor da propriedade
string
Comentários
category
Especifica a categoria de entradas a incluir no índice de autoridades. Os valores de 0 a 16 correspondem aos itens listados na caixa Categoria da caixa de diálogo Índice de Autoridades. Para saber como aceder a isto através da IU Word, veja Criar um índice de autoridades.
category: number;
Valor da propriedade
number
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
entrySeparator
Especifica um separador de até cinco carateres. Isto aparece entre a entrada da tabela de autoridades e o respetivo número de página.
entrySeparator: string;
Valor da propriedade
string
Comentários
isCategoryHeaderIncluded
Especifica se o nome da categoria de um grupo de entradas aparece no índice de autoridades.
isCategoryHeaderIncluded: boolean;
Valor da propriedade
boolean
Comentários
isEntryFormattingKept
Especifica se as entradas no índice de autoridades são apresentadas com a respetiva formatação na tabela.
isEntryFormattingKept: boolean;
Valor da propriedade
boolean
Comentários
isPassimUsed
Especifica se as referências à mesma autoridade repetidas em cinco ou mais páginas são substituídas por "Passim".
isPassimUsed: boolean;
Valor da propriedade
boolean
Comentários
pageNumberSeparator
Especifica um separador de até cinco carateres. Isto aparece entre referências de página individuais no índice de autoridades.
pageNumberSeparator: string;
Valor da propriedade
string
Comentários
pageRangeSeparator
Especifica um separador de até cinco carateres. Isto aparece entre intervalos de páginas no índice de autoridades.
pageRangeSeparator: string;
Valor da propriedade
string
Comentários
range
Obtém a parte de um documento que é esta tabela de autoridades.
readonly range: Word.Range;
Valor da propriedade
Comentários
sequenceName
Especifica o identificador de campo Sequência (SEQ) para o índice de autoridades.
sequenceName: string;
Valor da propriedade
string
Comentários
sequenceSeparator
Especifica um separador de até cinco carateres. Isto aparece entre o número de sequência e o número de página no índice de autoridades.
sequenceSeparator: string;
Valor da propriedade
string
Comentários
tabLeader
Especifica o caráter de preenchimento que aparece entre as entradas e os respetivos números de página associados no índice de autoridades.
tabLeader: Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot";
Valor da propriedade
Word.TabLeader | "Spaces" | "Dots" | "Dashes" | "Lines" | "Heavy" | "MiddleDot"
Comentários
Detalhes do método
delete()
Elimina este índice de autoridades.
delete(): void;
Retornos
void
Comentários
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.TableOfAuthoritiesLoadOptions): Word.TableOfAuthorities;
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.TableOfAuthorities;
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.TableOfAuthorities;
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.TableOfAuthoritiesUpdateData, options?: OfficeExtension.UpdateOptions): void;
Parâmetros
- properties
- Word.Interfaces.TableOfAuthoritiesUpdateData
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.TableOfAuthorities): void;
Parâmetros
- properties
- Word.TableOfAuthorities
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.TableOfAuthorities é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Word.Interfaces.TableOfAuthoritiesData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.
toJSON(): Word.Interfaces.TableOfAuthoritiesData;
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.TableOfAuthorities;
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.TableOfAuthorities;