Excel.ConditionalFormat class

Referência

Pacote:: excel

Um objeto encapsulando o intervalo, o formato, a regra e outras propriedades de um formato condicional. Para saber mais sobre o modelo de objeto de formatação condicional, leia Aplicar formatação condicional aos intervalos do Excel.

Extends: OfficeExtension.ClientObject

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

Propriedades

cellValue	Retorna as propriedades de formato condicional de valor celular se o formato condicional atual for um `CellValue` tipo.
cellValueOrNullObject	Retorna as propriedades de formato condicional de valor celular se o formato condicional atual for um `CellValue` tipo.
colorScale	Retorna as propriedades de formato condicional de escala de cor se o formato condicional atual for um `ColorScale` tipo.
colorScaleOrNullObject	Retorna as propriedades de formato condicional de escala de cor se o formato condicional atual for um `ColorScale` tipo.
context	O contexto de solicitação associado ao objeto. Isso conecta o processo do suplemento ao processo do aplicativo host do Office.
custom	Retorna as propriedades de formato condicional personalizado se o formato condicional atual for um tipo personalizado.
customOrNullObject	Retorna as propriedades de formato condicional personalizado se o formato condicional atual for um tipo personalizado.
dataBar	Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.
dataBarOrNullObject	Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.
iconSet	Retorna as propriedades de formato condicional de conjunto de ícones se o formato condicional atual for um `IconSet` tipo.
iconSetOrNullObject	Retorna as propriedades de formato condicional de conjunto de ícones se o formato condicional atual for um `IconSet` tipo.
id	A prioridade do formato condicional no atual `ConditionalFormatCollection`.
preset	Retorna o formato condicional de critérios predefinidos. Veja `Excel.PresetCriteriaConditionalFormat` para obter detalhes.
presetOrNullObject	Retorna o formato condicional de critérios predefinidos. Veja `Excel.PresetCriteriaConditionalFormat` para obter detalhes.
priority	A prioridade (ou índice) na coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar por trás. Prioridades maiores que os limites receberão e definirão como a prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.
stopIfTrue	Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está `null` em barras de dados, conjuntos de ícones e dimensionamentos de cores, pois não há nenhum conceito para `StopIfTrue` estes.
textComparison	Retorna as propriedades específicas de formato condicional de texto se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células que correspondem à palavra "Texto".
textComparisonOrNullObject	Retorna as propriedades específicas de formato condicional de texto se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células que correspondem à palavra "Texto".
topBottom	Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um `TopBottom` tipo. Por exemplo, para formatar os 10% ou 10 itens inferiores.
topBottomOrNullObject	Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um `TopBottom` tipo. Por exemplo, para formatar os 10% ou 10 itens inferiores.
type	Um tipo de formato condicional. Somente um pode ser definido por vez.

Métodos

changeRuleToCellValue(properties)	Altere o tipo de regra de formato condicional para o valor da célula.
changeRuleToColorScale()	Altere o tipo de regra de formato condicional para a escala de cores.
changeRuleToContainsText(properties)	Altere o tipo de regra de formato condicional para comparação de texto.
changeRuleToCustom(formula)	Altere o tipo de regra de formato condicional para personalizado.
changeRuleToDataBar()	Altere o tipo de regra de formato condicional para a barra de dados.
changeRuleToIconSet()	Altere o tipo de regra de formato condicional para o conjunto de ícones.
changeRuleToPresetCriteria(properties)	Altere o tipo de regra de formato condicional para critérios predefinidos.
changeRuleToTopBottom(properties)	Altere o tipo de regra de formato condicional para superior/inferior.
delete()	Exclui esse formato condicional.
getRange()	Retorna o intervalo ao qual a formatação condicional é aplicada. Gerará um erro se o formato condicional for aplicado a vários intervalos.
getRangeOrNullObject()	Retorna o intervalo ao qual o formato conditonal é aplicado. Se o formato condicional for aplicado a vários intervalos, esse método retornará um objeto com sua `isNullObject` propriedade definida como `true`. Para obter mais informações, consulte *Métodos e propriedades orNullObject.
getRanges()	Retorna o `RangeAreas`, que compreende um ou mais intervalos retangulares, aos quais o formato conditonal é aplicado.
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.
setRanges(ranges)	Defina os intervalos aos quais a regra de formato conditonal é aplicada.
toJSON()	Substitui o método JavaScript `toJSON()` para fornecer uma saída mais útil quando um objeto de API é passado para `JSON.stringify()`. (`JSON.stringify`por sua vez, chama o `toJSON` método do objeto que é passado para ele.) Enquanto o objeto Excel.ConditionalFormat original é um objeto API, o `toJSON` método retorna um objeto JavaScript simples (digitado como `Excel.Interfaces.ConditionalFormatData`) que contém cópias rasas de quaisquer propriedades filho carregadas do objeto original.

Detalhes da propriedade

cellValue

Retorna as propriedades de formato condicional de valor celular se o formato condicional atual for um CellValue tipo.

readonly cellValue: Excel.CellValueConditionalFormat;

Valor da propriedade

Excel.CellValueConditionalFormat

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("B21:E23");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.cellValue);
    conditionalFormat.cellValue.format.font.color = "red";
    conditionalFormat.cellValue.rule = { formula1: "=0", operator: "LessThan" };

    await context.sync();
});

cellValueOrNullObject

Retorna as propriedades de formato condicional de valor celular se o formato condicional atual for um CellValue tipo.

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Valor da propriedade

Excel.CellValueConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

colorScale

Retorna as propriedades de formato condicional de escala de cor se o formato condicional atual for um ColorScale tipo.

readonly colorScale: Excel.ColorScaleConditionalFormat;

Valor da propriedade

Excel.ColorScaleConditionalFormat

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();
});

colorScaleOrNullObject

Retorna as propriedades de formato condicional de escala de cor se o formato condicional atual for um ColorScale tipo.

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Valor da propriedade

Excel.ColorScaleConditionalFormat

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

custom

Retorna as propriedades de formato condicional personalizado se o formato condicional atual for um tipo personalizado.

readonly custom: Excel.CustomConditionalFormat;

Valor da propriedade

Excel.CustomConditionalFormat

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();
});

customOrNullObject

Retorna as propriedades de formato condicional personalizado se o formato condicional atual for um tipo personalizado.

readonly customOrNullObject: Excel.CustomConditionalFormat;

Valor da propriedade

Excel.CustomConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

dataBar

Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.

readonly dataBar: Excel.DataBarConditionalFormat;

Valor da propriedade

Excel.DataBarConditionalFormat

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.dataBar);
    conditionalFormat.dataBar.barDirection = Excel.ConditionalDataBarDirection.leftToRight;

    await context.sync();
});

dataBarOrNullObject

Retorna as propriedades da barra de dados se o formato condicional atual for uma barra de dados.

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Valor da propriedade

Excel.DataBarConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

iconSet

Retorna as propriedades de formato condicional de conjunto de ícones se o formato condicional atual for um IconSet tipo.

readonly iconSet: Excel.IconSetConditionalFormat;

Valor da propriedade

Excel.IconSetConditionalFormat

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.iconSet);
    const iconSetCF = conditionalFormat.iconSet;
    iconSetCF.style = Excel.IconSet.threeTriangles;

    /*
        The iconSetCF.criteria array is automatically prepopulated with
        criterion elements whose properties have been given default settings.
        You can't write to each property of a criterion directly. Instead,
        replace the whole criteria object.

        With a "three*" icon set style, such as "threeTriangles", the third
        element in the criteria array (criteria[2]) defines the "top" icon;
        e.g., a green triangle. The second (criteria[1]) defines the "middle"
        icon. The first (criteria[0]) defines the "low" icon, but it
        can often be left empty as the following object shows, because every
        cell that does not match the other two criteria always gets the low
        icon.            
    */
    iconSetCF.criteria = [
        {} as any,
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=700"
        },
        {
            type: Excel.ConditionalFormatIconRuleType.number,
            operator: Excel.ConditionalIconCriterionOperator.greaterThanOrEqual,
            formula: "=1000",
        }
    ];

    await context.sync();
});

iconSetOrNullObject

Retorna as propriedades de formato condicional de conjunto de ícones se o formato condicional atual for um IconSet tipo.

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Valor da propriedade

Excel.IconSetConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

id

A prioridade do formato condicional no atual ConditionalFormatCollection.

readonly id: string;

Valor da propriedade

string

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

preset

Retorna o formato condicional de critérios predefinidos. Veja Excel.PresetCriteriaConditionalFormat para obter detalhes.

readonly preset: Excel.PresetCriteriaConditionalFormat;

Valor da propriedade

Excel.PresetCriteriaConditionalFormat

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.presetCriteria);
    conditionalFormat.preset.format.font.color = "white";
    conditionalFormat.preset.rule = { criterion: Excel.ConditionalFormatPresetCriterion.oneStdDevAboveAverage };

    await context.sync();
});

presetOrNullObject

Retorna o formato condicional de critérios predefinidos. Veja Excel.PresetCriteriaConditionalFormat para obter detalhes.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Valor da propriedade

Excel.PresetCriteriaConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

priority

A prioridade (ou índice) na coleção de formato condicional em que esse formato condicional existe atualmente. Alterar isso também altera as prioridades de outros formatos condicionais, para permitir uma ordem de prioridade contígua. Use uma prioridade negativa para começar por trás. Prioridades maiores que os limites receberão e definirão como a prioridade máxima (ou mínima, se negativa). Observe também que, se você alterar a prioridade, precisará buscar novamente uma nova cópia do objeto nesse novo local de prioridade se quiser fazer mais alterações nele.

priority: number;

Valor da propriedade

number

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

stopIfTrue

Se as condições desse formato condicional forem atendidas, nenhum formato de prioridade mais baixa terá efeito nessa célula. O valor está null em barras de dados, conjuntos de ícones e dimensionamentos de cores, pois não há nenhum conceito para StopIfTrue estes.

stopIfTrue: boolean;

Valor da propriedade

boolean

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

textComparison

Retorna as propriedades específicas de formato condicional de texto se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células que correspondem à palavra "Texto".

readonly textComparison: Excel.TextConditionalFormat;

Valor da propriedade

Excel.TextConditionalFormat

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("B16:D18");
    const conditionalFormat = range.conditionalFormats
        .add(Excel.ConditionalFormatType.containsText);
    conditionalFormat.textComparison.format.font.color = "red";
    conditionalFormat.textComparison.rule = { operator: Excel.ConditionalTextOperator.contains, text: "Delayed" };

    await context.sync();
});

textComparisonOrNullObject

Retorna as propriedades específicas de formato condicional de texto se o formato condicional atual for um tipo de texto. Por exemplo, para formatar células que correspondem à palavra "Texto".

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Valor da propriedade

Excel.TextConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

topBottom

Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% ou 10 itens inferiores.

readonly topBottom: Excel.TopBottomConditionalFormat;

Valor da propriedade

Excel.TopBottomConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

topBottomOrNullObject

Retorna as propriedades de formato condicional superior/inferior se o formato condicional atual for um TopBottom tipo. Por exemplo, para formatar os 10% ou 10 itens inferiores.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Valor da propriedade

Excel.TopBottomConditionalFormat

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

type

Um tipo de formato condicional. Somente um pode ser definido por vez.

readonly type: Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue";

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 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.");
    }
});

Detalhes do método

changeRuleToCellValue(properties)

Altere o tipo de regra de formato condicional para o valor da célula.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Parâmetros

properties: Excel.ConditionalCellValueRule

As propriedades a serem definidas para a regra de formato condicional de valor celular.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToColorScale()

Altere o tipo de regra de formato condicional para a escala de cores.

changeRuleToColorScale(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToContainsText(properties)

Altere o tipo de regra de formato condicional para comparação de texto.

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Parâmetros

properties: Excel.ConditionalTextComparisonRule

As propriedades a serem definidas para a regra de formato condicional de comparação de texto.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToCustom(formula)

Altere o tipo de regra de formato condicional para personalizado.

changeRuleToCustom(formula: string): void;

Parâmetros

formula: string

A fórmula a ser definida para a regra de formato condicional personalizado.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToDataBar()

Altere o tipo de regra de formato condicional para a barra de dados.

changeRuleToDataBar(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToIconSet()

Altere o tipo de regra de formato condicional para o conjunto de ícones.

changeRuleToIconSet(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToPresetCriteria(properties)

Altere o tipo de regra de formato condicional para critérios predefinidos.

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Parâmetros

properties: Excel.ConditionalPresetCriteriaRule

As propriedades a serem definidas para a regra de formato condicional de critérios predefinidos.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToTopBottom(properties)

Altere o tipo de regra de formato condicional para superior/inferior.

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Parâmetros

properties: Excel.ConditionalTopBottomRule

As propriedades a serem definidas para a regra de formato condicional superior/inferior.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

delete()

Exclui esse formato condicional.

delete(): void;

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

getRange()

Retorna o intervalo ao qual a formatação condicional é aplicada. Gerará um erro se o formato condicional for aplicado a vários intervalos.

getRange(): Excel.Range;

Retornos

Excel.Range

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.");
    }
});

getRangeOrNullObject()

Retorna o intervalo ao qual o formato conditonal é aplicado. Se o formato condicional for aplicado a vários intervalos, esse método retornará um objeto com sua isNullObject propriedade definida como true. Para obter mais informações, consulte *Métodos e propriedades orNullObject.

getRangeOrNullObject(): Excel.Range;

Retornos

Excel.Range

Comentários

[ Conjunto de API: ExcelApi 1.6 ]

getRanges()

Retorna o RangeAreas, que compreende um ou mais intervalos retangulares, aos quais o formato conditonal é aplicado.

getRanges(): Excel.RangeAreas;

Retornos

Excel.RangeAreas

Comentários

[ Conjunto de API: ExcelApi 1.9 ]

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.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Parâmetros

options: Excel.Interfaces.ConditionalFormatLoadOptions

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

Retornos

Excel.ConditionalFormat

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

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

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

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

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

Parâmetros

properties: Excel.Interfaces.ConditionalFormatUpdateData

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

Parâmetros

properties: Excel.ConditionalFormat

Retornos

void

setRanges(ranges)

Defina os intervalos aos quais a regra de formato conditonal é aplicada.

setRanges(ranges: Range | RangeAreas | string): void;

Parâmetros

ranges: Excel.Range | Excel.RangeAreas | string

Coleção de um ou mais intervalos para que essa regra seja aplicada.

Retornos

void

Comentários

[ Conjunto de API: ExcelApi 1.17 ]

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

toJSON(): Excel.Interfaces.ConditionalFormatData;

Retornos

Excel.Interfaces.ConditionalFormatData

Compartilhar via

Excel.ConditionalFormat class

Comentários

Propriedades

Métodos

Detalhes da propriedade

cellValue

Valor da propriedade

Comentários

Exemplos

cellValueOrNullObject

Valor da propriedade

Comentários

colorScale

Valor da propriedade

Comentários

Exemplos

colorScaleOrNullObject

Valor da propriedade

Comentários

context

Valor da propriedade

custom

Valor da propriedade

Comentários

Exemplos

customOrNullObject

Valor da propriedade

Comentários

dataBar

Valor da propriedade

Comentários

Exemplos

dataBarOrNullObject

Valor da propriedade

Comentários

iconSet

Valor da propriedade

Comentários

Exemplos

iconSetOrNullObject

Valor da propriedade

Comentários

id

Valor da propriedade

Comentários

preset

Valor da propriedade

Comentários

Exemplos

presetOrNullObject

Valor da propriedade

Comentários

priority

Valor da propriedade

Comentários

stopIfTrue

Valor da propriedade

Comentários

textComparison

Valor da propriedade

Comentários

Exemplos

textComparisonOrNullObject

Valor da propriedade

Comentários

topBottom

Valor da propriedade

Comentários

topBottomOrNullObject

Valor da propriedade

Comentários

type

Valor da propriedade

Comentários

Exemplos

Detalhes do método

changeRuleToCellValue(properties)

Parâmetros

Retornos