Excel.CustomProperty class

Pacote:

excel

Representa uma propriedade personalizada.

Extends

OfficeExtension.ClientObject

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.
key	A chave da propriedade personalizada. A chave está limitada a 255 carateres fora do Excel na Web (as teclas maiores são automaticamente cortadas para 255 carateres noutras plataformas).
type	O tipo do valor utilizado para a propriedade personalizada.
value	O valor da propriedade personalizada. O valor está limitado a 255 carateres fora de Excel na Web (os valores maiores são automaticamente reduzidos para 255 carateres noutras plataformas).

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.CustomProperty é um objeto de API, o toJSON método devolve um objeto JavaScript simples (escrito como Excel.Interfaces.CustomPropertyData) 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

A chave da propriedade personalizada. A chave está limitada a 255 carateres fora do Excel na Web (as teclas maiores são automaticamente cortadas para 255 carateres noutras plataformas).

readonly key: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

type

O tipo do valor utilizado para a propriedade personalizada.

readonly type: Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float";

Valor da propriedade

Excel.DocumentPropertyType | "Number" | "Boolean" | "Date" | "String" | "Float"

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

value

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

value: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

Detalhes do método

delete()

Exclui a propriedade personalizada.

delete(): void;

Retornos

void

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.CustomPropertyLoadOptions): Excel.CustomProperty;

Parâmetros

options

Excel.Interfaces.CustomPropertyLoadOptions

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

Retornos

Excel.CustomProperty

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

Parâmetros

propertyNames

string | string[]

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

Retornos

Excel.CustomProperty

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

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

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.CustomPropertyUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parâmetros

properties

Excel.Interfaces.CustomPropertyUpdateData

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.CustomProperty): void;

Parâmetros

properties

Excel.CustomProperty

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

toJSON(): Excel.Interfaces.CustomPropertyData;

Retornos

Excel.Interfaces.CustomPropertyData