Excel.WorksheetCustomPropertyCollection class

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

Obtém os itens filhos carregados nesta coleção.

readonly items: Excel.WorksheetCustomProperty[];

Valor da propriedade

Adiciona uma nova propriedade personalizada que mapeia para a chave fornecida. Isso substitui as propriedades personalizadas existentes por essa chave.

add(key: string, value: string): Excel.WorksheetCustomProperty;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.12

Exemplos

// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/26-document/custom-properties.yaml

await Excel.run(async (context) => {
  // Get the key/value pair from the task pane.
  const userKey = document.getElementById("key").textContent;
  const userValue = document.getElementById("value").textContent;

  // Add the custom property.
  const customWorksheetProperties = context.workbook.worksheets.getActiveWorksheet().customProperties;
  customWorksheetProperties.add(userKey, userValue);

  await context.sync();

  console.log(`Successfully set custom worksheet property ${userKey}: ${userValue}.`);
});

Obtém o número de propriedades personalizadas nesta planilha.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.12

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Gera um erro se a propriedade personalizada não existir.

getItem(key: string): Excel.WorksheetCustomProperty;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.12

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada 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.WorksheetCustomProperty;

Parâmetros

Retornos

Comentários

Conjunto de APIs: ExcelApi 1.12

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.WorksheetCustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.WorksheetCustomPropertyCollection;

Parâmetros

Retornos

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

Parâmetros

Retornos

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

Parâmetros

Retornos

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 Excel.WorksheetCustomPropertyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.WorksheetCustomPropertyCollectionData) que contém uma matriz "items" com cópias superficiais de todas as propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.WorksheetCustomPropertyCollectionData;

Retornos