Excel.ConditionalFormatCollection class
Representa uma coleção de todos os formatos condicionais que se sobrepõem ao intervalo.
- 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. |
| items | Obtém os itens filhos carregados nesta coleção. |
Métodos
| add(type) | Adiciona um novo formato condicional à coleção na prioridade de primeira/superior. |
| add(type |
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior. |
| clear |
Limpa todos os formatos condicionais ativos no intervalo atual especificado. |
| get |
Retorna o número de formatos condicionais na pasta de trabalho. |
| get |
Retorna um formato condicional para o ID fornecido. |
| get |
Retorna um formato condicional no índice fornecido. |
| get |
Retorna um formato condicional identificado por sua ID. Se o objeto de formato condicional não existir, esse método retornará um objeto com sua |
| 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 |
| 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
items
Obtém os itens filhos carregados nesta coleção.
readonly items: Excel.ConditionalFormat[];Valor da propriedade
Detalhes do método
add(type)
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior.
add(type: Excel.ConditionalFormatType): Excel.ConditionalFormat;Parâmetros
O tipo de formato condicional que está sendo adicionado. Confira Excel.ConditionalFormatType detalhes.
Retornos
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("B2:M5");
const conditionalFormat = range.conditionalFormats
.add(Excel.ConditionalFormatType.colorScale);
const criteria = {
minimum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.lowestValue, color: "blue" },
midpoint: { formula: "50", type: Excel.ConditionalFormatColorCriterionType.percent, color: "yellow" },
maximum: { formula: null, type: Excel.ConditionalFormatColorCriterionType.highestValue, color: "red" }
};
conditionalFormat.colorScale.criteria = criteria;
await context.sync();
});
add(typeString)
Adiciona um novo formato condicional à coleção na prioridade de primeira/superior.
add(typeString: "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"): Excel.ConditionalFormat;Parâmetros
- typeString
-
"Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"
O tipo de formato condicional que está sendo adicionado. Confira Excel.ConditionalFormatType detalhes.
Retornos
Comentários
clearAll()
Limpa todos os formatos condicionais ativos no intervalo atual especificado.
clearAll(): void;Retornos
void
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();
range.conditionalFormats.clearAll();
await context.sync();
$(".conditional-formats").hide();
});
getCount()
Retorna o número de formatos condicionais na pasta de trabalho.
getCount(): OfficeExtension.ClientResult<number>;Retornos
OfficeExtension.ClientResult<number>
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Exemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormat = range.conditionalFormats.add(Excel.ConditionalFormatType.iconSet);
conditionalFormat.iconSetOrNullObject.style = Excel.IconSet.fourTrafficLights;
const cfCount = range.conditionalFormats.getCount();
await context.sync()
console.log("Count: " + cfCount.value);
});
getItem(id)
Retorna um formato condicional para o ID fornecido.
getItem(id: string): Excel.ConditionalFormat;Parâmetros
- id
-
string
A ID do formato condicional.
Retornos
Objeto de formato condicional.
Comentários
[ Conjunto de API: ExcelApi 1.6 ]
Exemplos
await Excel.run(async (context) => {
const sheetName = "Sheet1";
const rangeAddress = "A1:C3";
const range = context.workbook.worksheets.getItem(sheetName).getRange(rangeAddress);
const conditionalFormats = range.conditionalFormats;
const conditionalFormat = conditionalFormats.getItemAt(3);
await context.sync()
console.log("Conditional Format at Item 3 Loaded");
});
getItemAt(index)
Retorna um formato condicional no índice fornecido.
getItemAt(index: number): Excel.ConditionalFormat;Parâmetros
- index
-
number
Índice dos formatos condicionais a serem recuperados.
Retornos
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 worksheetRange = sheet.getRange();
worksheetRange.conditionalFormats.load("type");
await context.sync();
let cfRangePairs: { cf: Excel.ConditionalFormat, range: Excel.Range }[] = [];
worksheetRange.conditionalFormats.items.forEach(item => {
cfRangePairs.push({
cf: item,
range: item.getRange().load("address")
});
});
await context.sync();
if (cfRangePairs.length > 0) {
cfRangePairs.forEach(item => {
console.log(item.cf.type);
});
} else {
console.log("No conditional formats applied.");
}
});
getItemOrNullObject(id)
Retorna um formato condicional identificado por sua ID. Se o objeto de formato condicional não existir, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getItemOrNullObject(id: string): Excel.ConditionalFormat;Parâmetros
- id
-
string
A ID do formato condicional.
Retornos
Comentários
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.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions): Excel.ConditionalFormatCollection;Parâmetros
- options
-
Excel.Interfaces.ConditionalFormatCollectionLoadOptions & Excel.Interfaces.CollectionLoadOptions
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.ConditionalFormatCollection;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?: OfficeExtension.LoadOption): Excel.ConditionalFormatCollection;Parâmetros
- propertyNamesAndPaths
- OfficeExtension.LoadOption
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
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 original Excel.ConditionalFormatCollection é um objeto API, o toJSON método retorna um objeto JavaScript simples (digitado como Excel.Interfaces.ConditionalFormatCollectionData) que contém uma matriz de "itens" com cópias rasas de quaisquer propriedades carregadas dos itens da coleção.
toJSON(): Excel.Interfaces.ConditionalFormatCollectionData;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