Word.SettingCollection class
Contém a coleção de Word. Configurando objetos.
- Extends
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Deletes all custom settings this add-in had set on this document.
await Word.run(async (context) => {
const settings = context.document.settings;
settings.deleteAll();
await context.sync();
console.log("All settings deleted.");
});
Propriedades
context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
items | Obtém os itens filhos carregados nesta coleção. |
Métodos
add(key, value) | Cria uma nova configuração ou define uma configuração existente. |
delete |
Exclui todas as configurações neste suplemento. |
get |
Obtém a contagem de configurações. |
get |
Obtém um objeto de configuração por sua chave, que é sensível a maiúsculas de minúsculas. Gerará um |
get |
Obtém um objeto de configuração por sua chave, que é sensível a maiúsculas de minúsculas. Se a configuração não existir, esse método retornará um objeto com sua |
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 |
toJSON() | Substitui o método JavaScript |
track() | Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para context.trackedObjects.add(thisObject). Se você estiver usando esse objeto entre |
untrack() | Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar |
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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Word.Setting[];
Valor da propriedade
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Gets all custom settings this add-in set on this document.
await Word.run(async (context) => {
const settings = context.document.settings;
settings.load("items");
await context.sync();
if (settings.items.length == 0) {
console.log("There are no settings.");
} else {
console.log("All settings:");
for (let i = 0; i < settings.items.length; i++) {
console.log(settings.items[i]);
}
}
});
Detalhes do método
add(key, value)
Cria uma nova configuração ou define uma configuração existente.
add(key: string, value: any): Word.Setting;
Parâmetros
- key
-
string
Obrigatório. A chave da configuração, que é sensível a casos.
- value
-
any
Obrigatório. O valor da configuração.
Retornos
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/word/50-document/manage-settings.yaml
// Adds a new custom setting or
// edits the value of an existing one.
await Word.run(async (context) => {
const key = $("#key")
.val()
.toString();
if (key == "") {
console.error("Key shouldn't be empty.");
return;
}
const value = $("#value")
.val()
.toString();
const settings = context.document.settings;
const setting = settings.add(key, value);
setting.load();
await context.sync();
console.log("Setting added or edited:", setting);
});
deleteAll()
Exclui todas as configurações neste suplemento.
deleteAll(): void;
Retornos
void
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to get the count of settings.
const count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
// Queue a command to delete all settings.
settings.deleteAll();
// Queue a command to get the new count of settings.
count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
});
getCount()
Obtém a contagem de configurações.
getCount(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to get the count of settings.
const count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
// Queue a command to delete all settings.
settings.deleteAll();
// Queue a command to get the new count of settings.
count = settings.getCount();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(count.value);
});
getItem(key)
Obtém um objeto de configuração por sua chave, que é sensível a maiúsculas de minúsculas. Gerará um ItemNotFound
erro se a configuração não existir.
getItem(key: string): Word.Setting;
Parâmetros
- key
-
string
A chave que identifica o objeto de configuração.
Retornos
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue a command to retrieve a setting.
const startMonth = settings.getItem('startMonth');
// Queue a command to load the setting.
startMonth.load();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
console.log(JSON.stringify(startMonth.value));
});
getItemOrNullObject(key)
Obtém um objeto de configuração por sua chave, que é sensível a maiúsculas de minúsculas. Se a configuração não existir, esse método retornará um objeto com sua isNullObject
propriedade definida como true
. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(key: string): Word.Setting;
Parâmetros
- key
-
string
Obrigatório. A chave que identifica o objeto de configuração.
Retornos
Comentários
[ Conjunto de API: WordApi 1.4 ]
Exemplos
// Run a batch operation against the Word object model.
await Word.run(async (context) => {
// Queue commands add a setting.
const settings = context.document.settings;
settings.add('startMonth', { month: 'March', year: 1998 });
// Queue commands to retrieve settings.
const startMonth = settings.getItemOrNullObject('startMonth');
const endMonth = settings.getItemOrNullObject('endMonth');
// Queue commands to load settings.
startMonth.load();
endMonth.load();
// Synchronize the document state by executing the queued commands,
// and return a promise to indicate task completion.
await context.sync();
if (startMonth.isNullObject) {
console.log("No such setting.");
}
else {
console.log(JSON.stringify(startMonth.value));
}
if (endMonth.isNullObject) {
console.log("No such setting.");
}
else {
console.log(JSON.stringify(endMonth.value));
}
});
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.SettingCollectionLoadOptions & Word.Interfaces.CollectionLoadOptions): Word.SettingCollection;
Parâmetros
Fornece opções para quais propriedades do objeto 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.SettingCollection;
Parâmetros
- propertyNames
-
string | string[]
Uma cadeia de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.
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?: OfficeExtension.LoadOption): Word.SettingCollection;
Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
propertyNamesAndPaths.select
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades a serem carregadas e propertyNamesAndPaths.expand
é uma cadeia de caracteres delimitada por vírgulas que especifica as propriedades de navegação a serem carregadas.
Retornos
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.) Considerando que o objeto original Word.SettingCollection
é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Word.Interfaces.SettingCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Word.Interfaces.SettingCollectionData;
Retornos
track()
Acompanha o objeto para ajuste automático com base nas alterações adjacentes no documento. Essa chamada é uma abreviação para 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, você 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.SettingCollection;
Retornos
untrack()
Libere a memória associada a este objeto, se ele já tiver sido rastreado anteriormente. Essa 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. Você precisará chamar context.sync()
antes que a versão da memória entre em vigor.
untrack(): Word.SettingCollection;
Retornos
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de