Excel.SettingCollection class
Representa uma coleção de objetos de configuração de par de valor-chave que fazem parte da pasta de trabalho. O escopo é limitado a uma combinação de arquivo e suplemento (painel de tarefas ou conteúdo).
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.4 ]
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) | Define na pasta de trabalho ou adiciona a ela a configuração especificada. |
get |
Obtém o número de configurações na coleção. |
get |
Obtém uma entrada de configuração por meio da chave. |
get |
Obtém uma entrada de configuração por meio da chave. 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 |
Eventos
on |
Ocorre quando as configurações no documento são alteradas. |
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: Excel.Setting[];
Valor da propriedade
Detalhes do método
add(key, value)
Define na pasta de trabalho ou adiciona a ela a configuração especificada.
add(key: string, value: string | number | boolean | Date | any[] | any): Excel.Setting;
Parâmetros
- key
-
string
A chave da nova configuração.
- value
-
string | number | boolean | Date | any[] | any
O valor da nova configuração.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
getCount()
Obtém o número de configurações na coleção.
getCount(): OfficeExtension.ClientResult<number>;
Retornos
OfficeExtension.ClientResult<number>
Comentários
getItem(key)
Obtém uma entrada de configuração por meio da chave.
getItem(key: string): Excel.Setting;
Parâmetros
- key
-
string
Chave da configuração.
Retornos
Comentários
getItemOrNullObject(key)
Obtém uma entrada de configuração por meio da chave. 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): Excel.Setting;
Parâmetros
- key
-
string
A chave da configuração.
Retornos
Comentários
[ Conjunto de API: ExcelApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/50-workbook/create-get-change-delete-settings.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
let needsReview = settings.getItem("NeedsReview");
needsReview.delete();
needsReview = settings.getItemOrNullObject("NeedsReview");
await context.sync();
if (needsReview.isNullObject) {
console.log("The setting has been deleted");
} else {
console.log("The setting was not deleted");
}
await context.sync();
});
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?: Excel.Interfaces.SettingCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.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[]): Excel.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): Excel.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 Excel.SettingCollection
é um objeto API, o toJSON
método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.SettingCollectionData
) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.SettingCollectionData;
Retornos
Detalhes do evento
onSettingsChanged
Ocorre quando as configurações no documento são alteradas.
readonly onSettingsChanged: OfficeExtension.EventHandlers<Excel.SettingsChangedEventArgs>;
Tipo de evento
Comentários
[ Conjunto de API: ExcelApi 1.4 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/30-events/events-workbook-and-worksheet-collection.yaml
await Excel.run(async (context) => {
const settings = context.workbook.settings;
settings.onSettingsChanged.add(onChangedSetting);
await context.sync();
console.log("Settings changed handler registered.");
});
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