Excel.ConditionalRangeFormat class

Pacote:

excel

Um objeto de formato encapsulando a fonte, o preenchimento, as bordas e outras propriedades do intervalo de formatos condicionais.

Extends

OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

Propriedades

borders	Coleção de objetos de borda que se aplicam ao intervalo de formato condicional geral.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
fill	Retorna o objeto de preenchimento definido no intervalo de formato condicional geral.
font	Retorna o objeto de fonte definido no intervalo de formato condicional geral.
numberFormat	Representa o código de formato de número do Excel para o intervalo determinado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número. Desmarcado se null for passado.

Métodos

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.ConditionalRangeFormat original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ConditionalRangeFormatData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

borders

Coleção de objetos de borda que se aplicam ao intervalo de formato condicional geral.

readonly borders: Excel.ConditionalRangeBorderCollection;

Valor da propriedade

Excel.ConditionalRangeBorderCollection

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

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

fill

Retorna o objeto de preenchimento definido no intervalo de formato condicional geral.

readonly fill: Excel.ConditionalRangeFill;

Valor da propriedade

Excel.ConditionalRangeFill

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

font

Retorna o objeto de fonte definido no intervalo de formato condicional geral.

readonly font: Excel.ConditionalRangeFont;

Valor da propriedade

Excel.ConditionalRangeFont

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

numberFormat

Representa o código de formato de número do Excel para o intervalo determinado. Para obter mais informações sobre a formatação de números do Excel, consulte Códigos de formato de número. Desmarcado se null for passado.

numberFormat: any;

Valor da propriedade

any

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

Detalhes do método

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.ConditionalRangeFormatLoadOptions): Excel.ConditionalRangeFormat;

Parâmetros

options

Excel.Interfaces.ConditionalRangeFormatLoadOptions

Fornece opções para quais propriedades do objeto carregar.

Retornos

Excel.ConditionalRangeFormat

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

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

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

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

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

Parâmetros

properties

Excel.Interfaces.ConditionalRangeFormatUpdateData

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

Parâmetros

properties

Excel.ConditionalRangeFormat

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.ConditionalRangeFormat original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ConditionalRangeFormatData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

toJSON(): Excel.Interfaces.ConditionalRangeFormatData;

Retornos

Excel.Interfaces.ConditionalRangeFormatData