Excel.WorksheetCustomProperty class

Pacote:

excel

Representa uma propriedade personalizada ao nível da folha de cálculo.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

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.
key	Obtém a chave da propriedade personalizada. As chaves de propriedade personalizadas não são sensíveis a maiúsculas e minúsculas. A chave está limitada a 255 carateres (os valores maiores causarão um InvalidArgument erro.)
value	Obtém ou define o valor da propriedade personalizada.

Métodos

delete()	Exclui a propriedade personalizada.
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.
set(properties, options)	Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.
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.WorksheetCustomProperty é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetCustomPropertyData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

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

Excel.RequestContext

key

Obtém a chave da propriedade personalizada. As chaves de propriedade personalizadas não são sensíveis a maiúsculas e minúsculas. A chave está limitada a 255 carateres (os valores maiores causarão um InvalidArgument erro.)

readonly key: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

value

Obtém ou define o valor da propriedade personalizada.

value: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

Detalhes do método

delete()

Exclui a propriedade personalizada.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.12 ]

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.WorksheetCustomPropertyLoadOptions): Excel.WorksheetCustomProperty;

Parâmetros

options

Excel.Interfaces.WorksheetCustomPropertyLoadOptions

Fornece opções para as propriedades do objeto a carregar.

Retornos

Excel.WorksheetCustomProperty

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

Parâmetros

propertyNames

string | string[]

Uma cadeia delimitada por vírgulas ou uma matriz de cadeias que especificam as propriedades a carregar.

Retornos

Excel.WorksheetCustomProperty

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?: {
            select?: string;
            expand?: string;
        }): Excel.WorksheetCustomProperty;

Parâmetros

propertyNamesAndPaths

{ select?: string; expand?: string; }

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

Excel.WorksheetCustomProperty

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Pode transmitir um objeto simples com as propriedades adequadas ou outro objeto de API do mesmo tipo.

set(properties: Interfaces.WorksheetCustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Excel.Interfaces.WorksheetCustomPropertyUpdateData

Um objeto JavaScript com propriedades que são estruturadas isomorfoticamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto de propriedades tentar definir quaisquer propriedades só de leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base num objeto carregado existente.

set(properties: Excel.WorksheetCustomProperty): void;

Parâmetros

properties

Excel.WorksheetCustomProperty

Retornos

void

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.WorksheetCustomProperty é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.WorksheetCustomPropertyData) que contém cópias rasas de quaisquer propriedades subordinadas carregadas do objeto original.

toJSON(): Excel.Interfaces.WorksheetCustomPropertyData;

Retornos

Excel.Interfaces.WorksheetCustomPropertyData