Excel.CustomPropertyCollection class

Pacote:

excel

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

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

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 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. Gerará 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, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.CustomPropertyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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 de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.

context: RequestContext;

Valor da propriedade

Excel.RequestContext

items

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

readonly items: Excel.CustomProperty[];

Valor da propriedade

Excel.CustomProperty[]

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 é insensibilidade de maiúsculas de minúsculas. A chave é limitada a 255 caracteres fora de Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres em outras plataformas).

value

any

Obrigatório. O valor da propriedade personalizada. O valor é limitado a 255 caracteres fora do Excel na Web (valores maiores são cortados automaticamente para 255 caracteres em outras plataformas).

Retornos

Excel.CustomProperty

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

OfficeExtension.ClientResult<number>

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. Gerará 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 personalizado.

Retornos

Excel.CustomProperty

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

Parâmetros

key

string

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

Retornos

Excel.CustomProperty

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 quais propriedades do objeto carregar.

Retornos

Excel.CustomPropertyCollection

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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

Retornos

Excel.CustomPropertyCollection

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 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

Excel.CustomPropertyCollection

toJSON()

Substitui o método JavaScript toJSON() para fornecer uma saída mais útil quando um objeto de API é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Considerando que o objeto original Excel.CustomPropertyCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado 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

Excel.Interfaces.CustomPropertyCollectionData