Word.Index class

Pacote:: word

Representa um único índice. O Index objeto é um membro do Word. IndexCollection. Inclui IndexCollection todos os índices no documento.

Extends: OfficeExtension.ClientObject

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Usada por

Word. IndexCollection: add, getItem, items

Propriedades

context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
filter	Obtém um valor que representa como o Microsoft Word classifica o primeiro caractere das entradas no índice. Consulte `IndexFilter` os valores disponíveis.
headingSeparator	Obtém o texto entre grupos alfabéticos (entradas que começam com a mesma letra) no índice. Corresponde à \opção h para um campo INDEX.
indexLanguage	Obtém um `LanguageId` valor que representa a linguagem de classificação a ser usada para o índice.
numberOfColumns	Obtém o número de colunas para cada página do índice.
range	Retorna um `Range` objeto que representa a parte do documento contida no índice.
rightAlignPageNumbers	Especifica se os números de página estão alinhados com a margem direita no índice.
separateAccentedLetterHeadings	Obtém se o índice contiver títulos separados para letras acentuadas (por exemplo, palavras que começam com "À" estão sob um título e palavras que começam com "A" estão sob outro).
sortBy	Especifica os critérios de classificação do índice.
tabLeader	Especifica o caractere de preenchimento entre as entradas no índice e seus números de página associados.
type	Obtém o tipo de índice.

Métodos

delete()	Exclui esse índice.
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(propertyNames)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
load(propertyNamesAndPaths)	Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar `context.sync()` antes de ler as propriedades.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`, por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto original `Word.Index` é um objeto de API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Word.Interfaces.IndexData`) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.
track()	Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.
untrack()	Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar `context.sync()` antes que a liberação de memória entre em vigor.

Detalhes da propriedade

context

O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Word.RequestContext

filter

Obtém um valor que representa como o Microsoft Word classifica o primeiro caractere das entradas no índice. Consulte IndexFilter os valores disponíveis.

readonly filter: Word.IndexFilter | "None" | "Aiueo" | "Akasatana" | "Chosung" | "Low" | "Medium" | "Full";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

headingSeparator

Obtém o texto entre grupos alfabéticos (entradas que começam com a mesma letra) no índice. Corresponde à \opção h para um campo INDEX.

readonly headingSeparator: Word.HeadingSeparator | "None" | "BlankLine" | "Letter" | "LetterLow" | "LetterFull";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

indexLanguage

Obtém um LanguageId valor que representa a linguagem de classificação a ser usada para o índice.

readonly indexLanguage: Word.LanguageId | "Afrikaans" | "Albanian" | "Amharic" | "Arabic" | "ArabicAlgeria" | "ArabicBahrain" | "ArabicEgypt" | "ArabicIraq" | "ArabicJordan" | "ArabicKuwait" | "ArabicLebanon" | "ArabicLibya" | "ArabicMorocco" | "ArabicOman" | "ArabicQatar" | "ArabicSyria" | "ArabicTunisia" | "ArabicUAE" | "ArabicYemen" | "Armenian" | "Assamese" | "AzeriCyrillic" | "AzeriLatin" | "Basque" | "BelgianDutch" | "BelgianFrench" | "Bengali" | "Bulgarian" | "Burmese" | "Belarusian" | "Catalan" | "Cherokee" | "ChineseHongKongSAR" | "ChineseMacaoSAR" | "ChineseSingapore" | "Croatian" | "Czech" | "Danish" | "Divehi" | "Dutch" | "Edo" | "EnglishAUS" | "EnglishBelize" | "EnglishCanadian" | "EnglishCaribbean" | "EnglishIndonesia" | "EnglishIreland" | "EnglishJamaica" | "EnglishNewZealand" | "EnglishPhilippines" | "EnglishSouthAfrica" | "EnglishTrinidadTobago" | "EnglishUK" | "EnglishUS" | "EnglishZimbabwe" | "Estonian" | "Faeroese" | "Filipino" | "Finnish" | "French" | "FrenchCameroon" | "FrenchCanadian" | "FrenchCongoDRC" | "FrenchCotedIvoire" | "FrenchHaiti" | "FrenchLuxembourg" | "FrenchMali" | "FrenchMonaco" | "FrenchMorocco" | "FrenchReunion" | "FrenchSenegal" | "FrenchWestIndies" | "FrisianNetherlands" | "Fulfulde" | "GaelicIreland" | "GaelicScotland" | "Galician" | "Georgian" | "German" | "GermanAustria" | "GermanLiechtenstein" | "GermanLuxembourg" | "Greek" | "Guarani" | "Gujarati" | "Hausa" | "Hawaiian" | "Hebrew" | "Hindi" | "Hungarian" | "Ibibio" | "Icelandic" | "Igbo" | "Indonesian" | "Inuktitut" | "Italian" | "Japanese" | "Kannada" | "Kanuri" | "Kashmiri" | "Kazakh" | "Khmer" | "Kirghiz" | "Konkani" | "Korean" | "Kyrgyz" | "LanguageNone" | "Lao" | "Latin" | "Latvian" | "Lithuanian" | "MacedonianFYROM" | "Malayalam" | "MalayBruneiDarussalam" | "Malaysian" | "Maltese" | "Manipuri" | "Marathi" | "MexicanSpanish" | "Mongolian" | "Nepali" | "NoProofing" | "NorwegianBokmol" | "NorwegianNynorsk" | "Oriya" | "Oromo" | "Pashto" | "Persian" | "Polish" | "Portuguese" | "PortugueseBrazil" | "Punjabi" | "RhaetoRomanic" | "Romanian" | "RomanianMoldova" | "Russian" | "RussianMoldova" | "SamiLappish" | "Sanskrit" | "SerbianCyrillic" | "SerbianLatin" | "Sesotho" | "SimplifiedChinese" | "Sindhi" | "SindhiPakistan" | "Sinhalese" | "Slovak" | "Slovenian" | "Somali" | "Sorbian" | "Spanish" | "SpanishArgentina" | "SpanishBolivia" | "SpanishChile" | "SpanishColombia" | "SpanishCostaRica" | "SpanishDominicanRepublic" | "SpanishEcuador" | "SpanishElSalvador" | "SpanishGuatemala" | "SpanishHonduras" | "SpanishModernSort" | "SpanishNicaragua" | "SpanishPanama" | "SpanishParaguay" | "SpanishPeru" | "SpanishPuertoRico" | "SpanishUruguay" | "SpanishVenezuela" | "Sutu" | "Swahili" | "Swedish" | "SwedishFinland" | "SwissFrench" | "SwissGerman" | "SwissItalian" | "Syriac" | "Tajik" | "Tamazight" | "TamazightLatin" | "Tamil" | "Tatar" | "Telugu" | "Thai" | "Tibetan" | "TigrignaEritrea" | "TigrignaEthiopic" | "TraditionalChinese" | "Tsonga" | "Tswana" | "Turkish" | "Turkmen" | "Ukrainian" | "Urdu" | "UzbekCyrillic" | "UzbekLatin" | "Venda" | "Vietnamese" | "Welsh" | "Xhosa" | "Yi" | "Yiddish" | "Yoruba" | "Zulu";

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

numberOfColumns

Obtém o número de colunas para cada página do índice.

readonly numberOfColumns: number;

Valor da propriedade

number

Comentários

Conjunto de APIs: WordApiDesktop 1.4

range

Retorna um Range objeto que representa a parte do documento contida no índice.

readonly range: Word.Range;

Valor da propriedade

Word.Range

Comentários

Conjunto de APIs: WordApiDesktop 1.4

rightAlignPageNumbers

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

readonly rightAlignPageNumbers: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

separateAccentedLetterHeadings

Obtém se o índice contiver títulos separados para letras acentuadas (por exemplo, palavras que começam com "À" estão sob um título e palavras que começam com "A" estão sob outro).

readonly separateAccentedLetterHeadings: boolean;

Valor da propriedade

boolean

Comentários

Conjunto de APIs: WordApiDesktop 1.4

sortBy

Especifica os critérios de classificação do índice.

readonly sortBy: Word.IndexSortBy | "Stroke" | "Syllable";

Valor da propriedade

Word.IndexSortBy | "Stroke" | "Syllable"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

tabLeader

Especifica o caractere de preenchimento entre as entradas no índice e seus números de página associados.

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

Valor da propriedade

Comentários

Conjunto de APIs: WordApiDesktop 1.4

type

Obtém o tipo de índice.

readonly type: Word.IndexType | "Indent" | "Runin";

Valor da propriedade

Word.IndexType | "Indent" | "Runin"

Comentários

Conjunto de APIs: WordApiDesktop 1.4

Detalhes do método

delete()

Exclui esse índice.

delete(): void;

Retornos

void

Comentários

Conjunto de APIs: WordApiDesktop 1.4

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.IndexLoadOptions): Word.Index;

Parâmetros

options: Word.Interfaces.IndexLoadOptions

Fornece opções para quais propriedades do objeto devem ser carregadas.

Retornos

Word.Index

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.Index;

Parâmetros

propertyNames: string | string[]

Uma cadeia de caracteres delimitada por vírgula ou uma matriz de cadeias de caracteres que especifica as propriedades a serem carregadas.

Retornos

Word.Index

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.Index;

Parâmetros

propertyNamesAndPaths: { select?: string; expand?: string; }

propertyNamesAndPaths.select é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand é uma cadeia de caracteres delimitada por vírgula que especifica as propriedades de navegação a serem carregadas.

Retornos

Word.Index

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.

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

Parâmetros

properties: Word.Interfaces.IndexUpdateData

Um objeto JavaScript com propriedades estruturadas isomorficamente 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 propriedades somente leitura.

Retornos

void

set(properties)

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

set(properties: Word.Index): void;

Parâmetros

properties: Word.Index

Retornos

void

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringify, por sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto original Word.Index é um objeto de API, o toJSON método retorna um objeto JavaScript simples (digitado como Word.Interfaces.IndexData) que contém cópias superficiais de todas as propriedades filho carregadas do objeto original.

toJSON(): Word.Interfaces.IndexData;

Retornos

Word.Interfaces.IndexData

track()

Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação de context.trackedObjects.add(thisObject). Se você estiver usando esse 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, precisará adicionar o objeto à coleção de objetos rastreados quando o objeto foi criado pela primeira vez. Se esse objeto fizer parte de uma coleção, você também deverá acompanhar a coleção pai.

track(): Word.Index;

Retornos

Word.Index

untrack()

Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa chamada é a forma abreviada de 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. Você precisará ligar context.sync() antes que a liberação de memória entre em vigor.

untrack(): Word.Index;

Retornos

Word.Index

Comentários

Esta página foi útil?