Excel.CustomPropertyCollection class

Contém a coleção de propriedades personalizadas.

Extends

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Propriedades

context

O contexto do pedido associado ao objeto . Esta ação liga o processo do suplemento ao processo da aplicação anfitriã do Office.

items

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

Métodos

add(key, value)

Cria uma nova propriedade personalizada ou define uma existente.

deleteAll()

Exclui todas as propriedades personalizadas nesta coleção.

getCount()

Obtém a contagem das propriedades personalizadas.

getItem(key)

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.

getItemOrNullObject(key)

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

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.

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 Excel.CustomPropertyCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CustomPropertyCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

Detalhes da propriedade

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

items

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

readonly items: Excel.CustomProperty[];

Valor da propriedade

Detalhes do método

add(key, value)

Cria uma nova propriedade personalizada ou define uma existente.

add(key: string, value: any): Excel.CustomProperty;

Parâmetros

key

string

Obrigatório. A chave da propriedade personalizada, que não é sensível a maiúsculas e minúsculas. A chave está limitada a 255 carateres fora do Excel na Web (as teclas maiores são automaticamente cortadas para 255 carateres noutras plataformas).

value

any

Obrigatório. O valor da propriedade personalizada. O valor está limitado a 255 carateres fora do Excel na Web (os valores maiores são automaticamente reduzidos a 255 carateres noutras plataformas).

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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 = $("#key").text();
  const userValue = $("#value").text();

  // Add the custom property.
  const customDocProperties = context.workbook.properties.custom;
  customDocProperties.add(userKey, userValue);

  await context.sync();

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

deleteAll()

Exclui todas as propriedades personalizadas nesta coleção.

deleteAll(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

getCount()

Obtém a contagem das propriedades personalizadas.

getCount(): OfficeExtension.ClientResult<number>;

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

getItem(key)

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

Parâmetros

key

string

A chave que identifica o objeto de propriedade personalizada.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

getItemOrNullObject(key)

Obtém um objeto de propriedade personalizada por sua chave, que diferencia maiúsculas de minúsculas. Se a propriedade personalizada não existir, este método devolve um objeto com a respetiva isNullObject propriedade definida como true. Para obter mais informações, veja *OrNullObject methods and properties (Métodos e propriedades do OrNullObject).

getItemOrNullObject(key: string): Excel.CustomProperty;

Parâmetros

key

string

Obrigatório. A chave que identifica o objeto de propriedade personalizada.

Retornos

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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

Parâmetros

options

Excel.Interfaces.CustomPropertyCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions

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[]): Excel.CustomPropertyCollection;

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?: OfficeExtension.LoadOption): Excel.CustomPropertyCollection;

Parâmetros

propertyNamesAndPaths
OfficeExtension.LoadOption

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

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 Excel.CustomPropertyCollection é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CustomPropertyCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.

toJSON(): Excel.Interfaces.CustomPropertyCollectionData;

Retornos