Excel.ConditionalFormat class

Paquete:

excel

Objeto que encapsula el intervalo, el formato, la regla y otras propiedades de un formato condicional. Para obtener más información sobre el modelo de objetos de formato condicional, lea Aplicar formato condicional a intervalos de Excel.

Extends

OfficeExtension.ClientObject

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

Propiedades

cellValue	Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.
cellValueOrNullObject	Devuelve las propiedades de formato condicional del valor de celda si el formato condicional actual es un CellValue tipo.
colorScale	Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.
colorScaleOrNullObject	Devuelve las propiedades de formato condicional de escala de colores si el formato condicional actual es un ColorScale tipo.
context	Contexto de solicitud asociado al objeto . Esto conecta el proceso del complemento al proceso de la aplicación host de Office.
custom	Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.
customOrNullObject	Devuelve las propiedades de formato condicional personalizado si el formato condicional actual es un tipo personalizado.
dataBar	Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.
dataBarOrNullObject	Devuelve las propiedades de la barra de datos si el formato condicional actual es una barra de datos.
iconSet	Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.
iconSetOrNullObject	Devuelve las propiedades de formato condicional del conjunto de iconos si el formato condicional actual es un IconSet tipo.
id	Prioridad del formato condicional en el objeto actual ConditionalFormatCollection.
preset	Devuelve el formato condicional de los criterios preestablecidos. Consulte Excel.PresetCriteriaConditionalFormatpara obtener más información.
presetOrNullObject	Devuelve el formato condicional de los criterios preestablecidos. Consulte Excel.PresetCriteriaConditionalFormatpara obtener más información.
priority	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.
stopIfTrue	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.
textComparison	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".
textComparisonOrNullObject	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".
topBottom	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.
topBottomOrNullObject	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.
type	Tipo de formato condicional. Solo se puede establecer uno a la vez.

Métodos

changeRuleToCellValue(properties)	Cambie el tipo de regla de formato condicional al valor de celda.
changeRuleToColorScale()	Cambie el tipo de regla de formato condicional a escala de colores.
changeRuleToContainsText(properties)	Cambie el tipo de regla de formato condicional a la comparación de texto.
changeRuleToCustom(formula)	Cambie el tipo de regla de formato condicional a personalizado.
changeRuleToDataBar()	Cambie el tipo de regla de formato condicional a la barra de datos.
changeRuleToIconSet()	Cambie el tipo de regla de formato condicional a conjunto de iconos.
changeRuleToPresetCriteria(properties)	Cambie el tipo de regla de formato condicional a criterios preestablecidos.
changeRuleToTopBottom(properties)	Cambie el tipo de regla de formato condicional a superior o inferior.
delete()	Elimina este formato condicional.
getRange()	Devuelve el intervalo en el que se aplica el formato condicional. Produce un error si el formato condicional se aplica a varios intervalos.
getRangeOrNullObject()	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).
getRanges()	Devuelve , RangeAreasque comprende uno o varios intervalos rectangulares, a los que se aplica el formato conditonal.
load(options)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNames)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
load(propertyNamesAndPaths)	Pone en cola un comando para cargar las propiedades especificadas del objeto. Debe llamar a context.sync() antes de leer las propiedades.
set(properties, options)	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)	Establece varias propiedades en el objeto al mismo tiempo, en función de un objeto cargado existente.
setRanges(ranges)	Establezca los intervalos a los que se aplica la regla de formato conditonal.
toJSON()	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.

Detalles de las propiedades

cellValue

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

Excel.CellValueConditionalFormat

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

cellValueOrNullObject

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

Excel.CellValueConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

colorScale

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

Excel.ColorScaleConditionalFormat

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

colorScaleOrNullObject

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

Excel.ColorScaleConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

context

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

Excel.RequestContext

custom

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

readonly custom: Excel.CustomConditionalFormat;

Valor de propiedad

Excel.CustomConditionalFormat

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

customOrNullObject

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

readonly customOrNullObject: Excel.CustomConditionalFormat;

Valor de propiedad

Excel.CustomConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

dataBar

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

Excel.DataBarConditionalFormat

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

dataBarOrNullObject

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

Excel.DataBarConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

iconSet

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

Excel.IconSetConditionalFormat

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

iconSetOrNullObject

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

Excel.IconSetConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

id

Prioridad del formato condicional en el objeto actual ConditionalFormatCollection.

readonly id: string;

Valor de propiedad

string

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

preset

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

readonly preset: Excel.PresetCriteriaConditionalFormat;

Valor de propiedad

Excel.PresetCriteriaConditionalFormat

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

presetOrNullObject

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

readonly presetOrNullObject: Excel.PresetCriteriaConditionalFormat;

Valor de propiedad

Excel.PresetCriteriaConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

priority

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

number

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

stopIfTrue

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

boolean

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

textComparison

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

Excel.TextConditionalFormat

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

textComparisonOrNullObject

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

Excel.TextConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

topBottom

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

Excel.TopBottomConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

topBottomOrNullObject

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

Excel.TopBottomConditionalFormat

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

type

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

Excel.ConditionalFormatType | "Custom" | "DataBar" | "ColorScale" | "IconSet" | "TopBottom" | "PresetCriteria" | "ContainsText" | "CellValue"

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

Detalles del método

changeRuleToCellValue(properties)

Cambie el tipo de regla de formato condicional al valor de celda.

changeRuleToCellValue(properties: Excel.ConditionalCellValueRule): void;

Parámetros

properties

Excel.ConditionalCellValueRule

Propiedades que se van a establecer para la regla de formato condicional del valor de celda.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToColorScale()

Cambie el tipo de regla de formato condicional a escala de colores.

changeRuleToColorScale(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToContainsText(properties)

Cambie el tipo de regla de formato condicional a la comparación de texto.

changeRuleToContainsText(properties: Excel.ConditionalTextComparisonRule): void;

Parámetros

properties

Excel.ConditionalTextComparisonRule

Propiedades que se van a establecer para la regla de formato condicional de comparación de texto.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToCustom(formula)

Cambie el tipo de regla de formato condicional a personalizado.

changeRuleToCustom(formula: string): void;

Parámetros

formula

string

Fórmula que se va a establecer para la regla de formato condicional personalizada.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToDataBar()

Cambie el tipo de regla de formato condicional a la barra de datos.

changeRuleToDataBar(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToIconSet()

Cambie el tipo de regla de formato condicional a conjunto de iconos.

changeRuleToIconSet(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToPresetCriteria(properties)

Cambie el tipo de regla de formato condicional a criterios preestablecidos.

changeRuleToPresetCriteria(properties: Excel.ConditionalPresetCriteriaRule): void;

Parámetros

properties

Excel.ConditionalPresetCriteriaRule

Propiedades que se van a establecer para la regla de formato condicional de criterios preestablecidos.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

changeRuleToTopBottom(properties)

Cambie el tipo de regla de formato condicional a superior o inferior.

changeRuleToTopBottom(properties: Excel.ConditionalTopBottomRule): void;

Parámetros

properties

Excel.ConditionalTopBottomRule

Propiedades que se van a establecer para la regla de formato condicional superior o inferior.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

delete()

Elimina este formato condicional.

delete(): void;

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

getRange()

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

Excel.Range

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

getRangeOrNullObject()

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

Excel.Range

Comentarios

[ Conjunto de API: ExcelApi 1.6 ]

getRanges()

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

getRanges(): Excel.RangeAreas;

Devoluciones

Excel.RangeAreas

Comentarios

[ Conjunto de API: ExcelApi 1.9 ]

load(options)

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

options

Excel.Interfaces.ConditionalFormatLoadOptions

Proporciona opciones para las propiedades del objeto que se van a cargar.

Devoluciones

Excel.ConditionalFormat

load(propertyNames)

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

propertyNames

string | string[]

Una cadena delimitada por comas o una matriz de cadenas que especifican las propiedades que se van a cargar.

Devoluciones

Excel.ConditionalFormat

load(propertyNamesAndPaths)

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

propertyNamesAndPaths

{ select?: string; expand?: string; }

propertyNamesAndPaths.select es una cadena delimitada por comas que especifica las propiedades que se van a cargar y propertyNamesAndPaths.expand es una cadena delimitada por comas que especifica las propiedades de navegación que se van a cargar.

Devoluciones

Excel.ConditionalFormat

set(properties, options)

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

properties

Excel.Interfaces.ConditionalFormatUpdateData

Objeto JavaScript con propiedades estructuradas isomórficamente con las propiedades del objeto al que se llama al método.

options

OfficeExtension.UpdateOptions

Proporciona una opción para suprimir errores si el objeto properties intenta establecer propiedades de solo lectura.

Devoluciones

void

set(properties)

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

set(properties: Excel.ConditionalFormat): void;

Parámetros

properties

Excel.ConditionalFormat

Devoluciones

void

setRanges(ranges)

Establezca los intervalos a los que se aplica la regla de formato conditonal.

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

Parámetros

ranges

Excel.Range | Excel.RangeAreas | string

Colección de uno o más intervalos a los que se va a aplicar esta regla.

Devoluciones

void

Comentarios

[ Conjunto de API: ExcelApi 1.17 ]

toJSON()

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

Excel.Interfaces.ConditionalFormatData