Excel.CustomConditionalFormat class
Representa um tipo de formato condicional personalizado.
- Extends
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Propriedades
| context | O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office. |
| format | Retorna um objeto de formato, encapsulando a fonte de formatos condicionais, preenchimento, bordas e outras propriedades. |
| rule | Especifica o |
Métodos
| load(options) | Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| load(property |
Coloca um comando na fila para carregar as propriedades especificadas do objeto. Você deve chamar |
| 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 |
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
format
Retorna um objeto de formato, encapsulando a fonte de formatos condicionais, preenchimento, bordas e outras propriedades.
readonly format: Excel.ConditionalRangeFormat;Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Exemplos
// Link to full sample: https://raw.githubusercontent.com/OfficeDev/office-js-snippets/prod/samples/excel/14-conditional-formatting/conditional-formatting-basic.yaml
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getItem("Sample");
const range = sheet.getRange("B8:E13");
const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
conditionalFormat.custom.rule.formula = '=IF(B8>INDIRECT("RC[-1]",0),TRUE)';
conditionalFormat.custom.format.font.color = "green";
await context.sync();
});
rule
Especifica o Rule objeto nesse formato condicional.
readonly rule: Excel.ConditionalFormatRule;Valor da propriedade
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Exemplos
await Excel.run(async (context) => {
const sheet = context.workbook.worksheets.getActiveWorksheet();
const range = sheet.getRange("A1:A5");
range.values = [[1], [20], [""], [5], ["test"]];
const cf = range.conditionalFormats.add(Excel.ConditionalFormatType.custom);
const cfCustom = cf.customOrNullObject;
cfCustom.rule.formula = "=ISBLANK(A1)";
cfCustom.format.fill.color = "#00FF00";
await context.sync()
console.log("Added new custom conditional format highlighting all blank cells.");
});
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.CustomConditionalFormatLoadOptions): Excel.CustomConditionalFormat;Parâmetros
Fornece opções para quais propriedades do objeto carregar.
Retornos
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.CustomConditionalFormat;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
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.CustomConditionalFormat;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
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.CustomConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;Parâmetros
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.CustomConditionalFormat): void;Parâmetros
- properties
- Excel.CustomConditionalFormat
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.) Considerando que o objeto Excel.CustomConditionalFormat original é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.CustomConditionalFormatData) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.
toJSON(): Excel.Interfaces.CustomConditionalFormatData;Retornos
Comentários
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulte https://aka.ms/ContentUserFeedback.
Enviar e exibir comentários de