Excel.CustomProperty class

Pacote:

excel

Representa uma propriedade personalizada.

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.
key	A chave da propriedade personalizada. A chave é limitada a 255 caracteres fora de Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres em outras plataformas).
type	O tipo do valor usado para a propriedade personalizada.
value	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).

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. Você pode passar um objeto simples com as propriedades apropriadas ou outro objeto de API do mesmo tipo.
set(properties)	Define várias propriedades no objeto ao mesmo tempo, com base em um objeto carregado existente.
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.) Enquanto o objeto Excel.CustomProperty original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomPropertyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

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

key

A chave da propriedade personalizada. A chave é limitada a 255 caracteres fora de Excel na Web (chaves maiores são cortadas automaticamente para 255 caracteres em outras plataformas).

readonly key: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.7 ]

type

O tipo do valor usado 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 é limitado a 255 caracteres fora do Excel na Web (valores maiores são cortados automaticamente para 255 caracteres em outras 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 quais propriedades do objeto 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 de caracteres delimitada por vírgulas ou uma matriz de cadeias de caracteres que especificam as propriedades a serem carregadas.

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

set(properties, options)

Define várias propriedades de um objeto ao mesmo tempo. Você pode passar um objeto simples com as propriedades apropriadas 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 estruturadas isomorficamente para as propriedades do objeto no qual o método é chamado.

options

OfficeExtension.UpdateOptions

Fornece uma opção para suprimir erros se o objeto properties tentar definir quaisquer propriedades somente leitura.

Retornos

void

set(properties)

Define várias propriedades no objeto ao mesmo tempo, com base em um 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 é passado para JSON.stringify(). (JSON.stringifypor sua vez, chama o toJSON método do objeto que é passado para ele.) Enquanto o objeto Excel.CustomProperty original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomPropertyData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.CustomPropertyData;

Retornos

Excel.Interfaces.CustomPropertyData