Excel.ConditionalFormat class

Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.

readonly cellValue: Excel.CellValueConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.

readonly cellValueOrNullObject: Excel.CellValueConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.

readonly colorScale: Excel.ColorScaleConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.

readonly colorScaleOrNullObject: Excel.ColorScaleConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.

context: RequestContext;

Valor de propiedad

Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.

readonly custom: Excel.CustomConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.

readonly customOrNullObject: Excel.CustomConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.

readonly dataBar: Excel.DataBarConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.

readonly dataBarOrNullObject: Excel.DataBarConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.

readonly iconSet: Excel.IconSetConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.

readonly iconSetOrNullObject: Excel.IconSetConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Prioridad del formato condicional en el objeto actual ConditionalFormatCollection.

readonly id: string;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve el formato condicional de los criterios preestablecidos. Consulte Excel.PresetCriteriaConditionalFormatpara obtener más información.

readonly preset: Excel.PresetCriteriaConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve el formato condicional de los criterios preestablecidos. Consulte Excel.PresetCriteriaConditionalFormatpara obtener más información.

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Prioridad (o índice) dentro de la colección de formato condicional en la que existe actualmente este formato condicional. Cambiar esto también cambia las prioridades de otros formatos condicionales, para permitir un orden de prioridad contiguo. Use una prioridad negativa para comenzar desde atrás. Las prioridades mayores que los límites se obtienen y establecen en la prioridad máxima (o mínima si es negativa). Tenga en cuenta también que si cambia la prioridad, tendrá que volver a capturar una nueva copia del objeto en esa nueva ubicación de prioridad si desea realizar más cambios en él.

priority: number;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Si se cumplen las condiciones de este formato condicional, los formatos de menor prioridad no surtirán efecto en esa celda. El valor está null en las barras de datos, los conjuntos de iconos y las escalas de colores, ya que no hay ningún concepto de StopIfTrue para ellas.

stopIfTrue: boolean;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de formato condicional de texto específicas si el formato condicional actual es un tipo de texto. Por ejemplo, para dar formato a celdas que coincidan con la palabra "Texto".

readonly textComparison: Excel.TextConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve las propiedades de formato condicional de texto específicas si el formato condicional actual es un tipo de texto. Por ejemplo, para dar formato a celdas que coincidan con la palabra "Texto".

readonly textComparisonOrNullObject: Excel.TextConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de formato condicional superior e inferior si el formato condicional actual es un TopBottom tipo. Por ejemplo, para dar formato al 10 % superior o inferior 10 elementos.

readonly topBottom: Excel.TopBottomConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve las propiedades de formato condicional superior e inferior si el formato condicional actual es un TopBottom tipo. Por ejemplo, para dar formato al 10 % superior o inferior 10 elementos.

readonly topBottomOrNullObject: Excel.TopBottomConditionalFormat;

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Tipo de formato condicional. Solo se puede establecer uno a la vez.

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

Valor de propiedad

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Elimina este formato condicional.

delete(): void;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve el intervalo en el que se aplica el formato condicional. Produce un error si el formato condicional se aplica a varios intervalos.

getRange(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Ejemplos

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

Devuelve el intervalo al que se aplica el formato conditonal. Si el formato condicional se aplica a varios intervalos, este método devuelve un objeto con su isNullObject propiedad establecida en true. Para obtener más información, vea *OrNullObject methods and properties( Métodos y propiedades de *OrNullObject).

getRangeOrNullObject(): Excel.Range;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Devuelve , RangeAreasque comprende uno o varios intervalos rectangulares, a los que se aplica el formato conditonal.

getRanges(): Excel.RangeAreas;

Devoluciones

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(options?: Excel.Interfaces.ConditionalFormatLoadOptions): Excel.ConditionalFormat;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNames?: string | string[]): Excel.ConditionalFormat;

Parámetros

Devoluciones

Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.

load(propertyNamesAndPaths?: {
            select?: string;
            expand?: string;
        }): Excel.ConditionalFormat;

Parámetros

Devoluciones

Establece varias propiedades de un objeto al mismo tiempo. Puede pasar un objeto sin formato con las propiedades adecuadas u otro objeto de API del mismo tipo.

set(properties: Interfaces.ConditionalFormatUpdateData, options?: OfficeExtension.UpdateOptions): void;

Parámetros

Devoluciones

Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.

set(properties: Excel.ConditionalFormat): void;

Parámetros

Devoluciones

Invalida el método JavaScript toJSON() para proporcionar una salida más útil cuando se pasa un objeto de API a JSON.stringify(). (JSON.stringifya su vez, llama al toJSON método del objeto que se le pasa). Mientras que el objeto original Excel.ConditionalFormat es un objeto de API, el toJSON método devuelve un objeto JavaScript sin formato (escrito como Excel.Interfaces.ConditionalFormatData) que contiene copias superficiales de las propiedades secundarias cargadas del objeto original.

toJSON(): Excel.Interfaces.ConditionalFormatData;

Devoluciones