Class ConditionalFormatting

Namespace

SheetStream

Assembly

SheetStream.dll

Conditional formatting rules over one range. Create through AddConditionalFormatting(string) and chain any number of rules; earlier rules win when several match (Excel priority order).

public sealed class ConditionalFormatting

Inheritance

object

ConditionalFormatting

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.ReferenceEquals(object, object)

object.ToString()

Examples

var bad = workbook.Styles.CreateDifferential(o => { o.Font.Color = "#9C0006"; o.Fill.BackgroundColor = "#FFC7CE"; });
sheet.AddConditionalFormatting("C2:C101")
     .CellValue(ConditionalOperator.LessThan, "0", bad)
     .DataBar("#638EC6");

Methods

AboveAverage(DifferentialStyle)

Formats values above the range average.

public ConditionalFormatting AboveAverage(DifferentialStyle style)

Parameters

style DifferentialStyle

Returns

ConditionalFormatting

BelowAverage(DifferentialStyle)

Formats values below the range average.

public ConditionalFormatting BelowAverage(DifferentialStyle style)

Parameters

style DifferentialStyle

Returns

ConditionalFormatting

Bottom(int, DifferentialStyle, bool)

Formats the bottom rank values (or bottom percent).

public ConditionalFormatting Bottom(int rank, DifferentialStyle style, bool percent = false)

Parameters

rank int

style DifferentialStyle

percent bool

Returns

ConditionalFormatting

CellValue(ConditionalOperator, string, DifferentialStyle, string?)

Formats cells whose value compares to one or two values or formulas (written without "=").

public ConditionalFormatting CellValue(ConditionalOperator op, string value1, DifferentialStyle style, string? value2 = null)

Parameters

op ConditionalOperator

value1 string

style DifferentialStyle

value2 string

Returns

ConditionalFormatting

ColorScale(string, string)

Two-colour scale from the lowest to the highest value.

public ConditionalFormatting ColorScale(string minColor, string maxColor)

Parameters

minColor string

maxColor string

Returns

ConditionalFormatting

ColorScale(string, string, string)

Three-colour scale: lowest, 50th percentile, highest (e.g. red, yellow, green).

public ConditionalFormatting ColorScale(string minColor, string midColor, string maxColor)

Parameters

minColor string

midColor string

maxColor string

Returns

ConditionalFormatting

ContainsText(string, DifferentialStyle)

Formats cells whose text contains text (case-insensitive, like Excel).

public ConditionalFormatting ContainsText(string text, DifferentialStyle style)

Parameters

text string

style DifferentialStyle

Returns

ConditionalFormatting

DataBar(string)

In-cell data bars scaled from the lowest to the highest value.

public ConditionalFormatting DataBar(string color)

Parameters

color string

Returns

ConditionalFormatting

DuplicateValues(DifferentialStyle)

Formats values that appear more than once in the range.

public ConditionalFormatting DuplicateValues(DifferentialStyle style)

Parameters

style DifferentialStyle

Returns

ConditionalFormatting

Expression(string, DifferentialStyle)

Formats cells where the formula is TRUE. Write it relative to the range's top-left cell, e.g. "$C2>$D2" for a range starting in row 2, to colour whole rows.

public ConditionalFormatting Expression(string formula, DifferentialStyle style)

Parameters

formula string

style DifferentialStyle

Returns

ConditionalFormatting

IconSet(IconSetType, bool, bool)

Icon set with thresholds at equal percentage steps.

public ConditionalFormatting IconSet(IconSetType type, bool reverse = false, bool showValue = true)

Parameters

type IconSetType

reverse bool

showValue bool

Returns

ConditionalFormatting

Top(int, DifferentialStyle, bool)

Formats the top rank values (or top percent).

public ConditionalFormatting Top(int rank, DifferentialStyle style, bool percent = false)

Parameters

rank int

style DifferentialStyle

percent bool

Returns

ConditionalFormatting

UniqueValues(DifferentialStyle)

Formats values that appear exactly once in the range.

public ConditionalFormatting UniqueValues(DifferentialStyle style)

Parameters

style DifferentialStyle

Returns

ConditionalFormatting