API Reference

Class

ExcelRangeConditionalFormattingBuilder

Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Modifiers sealed

Fluent conditional formatting builder for an ExcelRange.

Inheritance

  • Object
  • ExcelRangeConditionalFormattingBuilder

Usage

This type appears in these public API surfaces even when no hand-authored example is attached directly to the page.

Returned or exposed by

Methods

AboveAverage 3 overloads
public ExcelRange AboveAverage() #
Returns: ExcelRange

Applies an above-average rule.

public ExcelRange AboveAverage(Boolean equalAverage = false, Nullable<UInt32> standardDeviation = null) #
Returns: ExcelRange

Applies an above-average rule with an optional solid fill.

Parameters

fillColor System.String = false optionalposition: 0
equalAverage System.Boolean = null optionalposition: 1
AboveAverage(System.Boolean equalAverage, System.Nullable{System.UInt32} standardDeviation) #

Applies an above-average rule.

Parameters

equalAverage System.Boolean required
standardDeviation System.Nullable{System.UInt32} required
public ExcelRange BeginsWith(String text) #
Returns: ExcelRange

Applies a begins-with text rule.

Parameters

text System.String requiredposition: 0
BeginsWithText 2 overloads
public ExcelRange BeginsWithText(String text) #
Returns: ExcelRange

Applies a begins-with-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange BeginsWithText(String text, String fillColor) #
Returns: ExcelRange

Applies a begins-with-text rule with an optional solid fill.

Parameters

text System.String requiredposition: 0
fillColor System.String requiredposition: 1
BelowAverage 3 overloads
public ExcelRange BelowAverage() #
Returns: ExcelRange

Applies a below-average rule.

public ExcelRange BelowAverage(Boolean equalAverage = false, Nullable<UInt32> standardDeviation = null) #
Returns: ExcelRange

Applies a below-average rule with an optional solid fill.

Parameters

fillColor System.String = false optionalposition: 0
equalAverage System.Boolean = null optionalposition: 1
BelowAverage(System.Boolean equalAverage, System.Nullable{System.UInt32} standardDeviation) #

Applies a below-average rule.

Parameters

equalAverage System.Boolean required
standardDeviation System.Nullable{System.UInt32} required
Between 2 overloads
public ExcelRange Between(String formula1, String formula2) #
Returns: ExcelRange

Applies a between cell-value rule.

Parameters

formula1 System.String requiredposition: 0
formula2 System.String requiredposition: 1
public ExcelRange Between(String formula1, String formula2, String fillColor) #
Returns: ExcelRange

Applies a between cell-value rule.

Parameters

formula1 System.String requiredposition: 0
formula2 System.String requiredposition: 1
fillColor System.String requiredposition: 2
public ExcelRange Blanks() #
Returns: ExcelRange

Applies a blanks rule.

Bottom 2 overloads
public ExcelRange Bottom(UInt32 rank, Boolean percent = false) #
Returns: ExcelRange

Applies a bottom-values rule.

Parameters

rank System.UInt32 requiredposition: 0
percent System.Boolean = false optionalposition: 1
public ExcelRange Bottom(UInt32 rank, String fillColor, Boolean percent = false) #
Returns: ExcelRange

Applies a bottom-values rule with an optional solid fill.

Parameters

rank System.UInt32 requiredposition: 0
fillColor System.String requiredposition: 1
percent System.Boolean = false optionalposition: 2
CellIs 3 overloads
public ExcelRange CellIs(ConditionalFormattingOperatorValues operator, String formula1) #
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.ConditionalFormattingOperatorValues requiredposition: 0
formula1 System.String requiredposition: 1
public ExcelRange CellIs(ConditionalFormattingOperatorValues operator, String formula1, String formula2) #
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.ConditionalFormattingOperatorValues requiredposition: 0
formula1 System.String requiredposition: 1
formula2 System.String requiredposition: 2
public ExcelRange CellIs(ConditionalFormattingOperatorValues operator, String formula1, String formula2 = null, String fillColor = null) #
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator DocumentFormat.OpenXml.Spreadsheet.ConditionalFormattingOperatorValues requiredposition: 0
formula1 System.String requiredposition: 1
formula2 System.String = null optionalposition: 2
fillColor System.String = null optionalposition: 3
public ExcelRange Clear() #
Returns: ExcelRange

Removes conditional formatting rules that overlap the range.

ColorScale 2 overloads
public ExcelRange ColorScale(OfficeColor startColor, OfficeColor endColor) #
Returns: ExcelRange

Applies a two-color scale.

Parameters

arg1 OfficeIMO.Drawing.OfficeColor requiredposition: 0
arg2 OfficeIMO.Drawing.OfficeColor requiredposition: 1
public ExcelRange ColorScale(String startColor, String endColor) #
Returns: ExcelRange

Applies a two-color scale using hex colors.

Parameters

startColor System.String requiredposition: 0
endColor System.String requiredposition: 1
ContainsText 2 overloads
public ExcelRange ContainsText(String text) #
Returns: ExcelRange

Applies a contains-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange ContainsText(String text, String fillColor) #
Returns: ExcelRange

Applies a contains-text rule with an optional solid fill.

Parameters

text System.String requiredposition: 0
fillColor System.String requiredposition: 1
DataBar 2 overloads
public ExcelRange DataBar(OfficeColor color) #
Returns: ExcelRange

Applies a data bar.

Parameters

arg1 OfficeIMO.Drawing.OfficeColor requiredposition: 0
public ExcelRange DataBar(String color) #
Returns: ExcelRange

Applies a data bar using a hex color.

Parameters

color System.String requiredposition: 0
DuplicateValues 2 overloads
public ExcelRange DuplicateValues() #
Returns: ExcelRange

Applies a duplicate-values rule.

public ExcelRange DuplicateValues(String fillColor) #
Returns: ExcelRange

Applies a duplicate-values rule with an optional solid fill.

Parameters

fillColor System.String requiredposition: 0
public ExcelRange EndsWith(String text) #
Returns: ExcelRange

Applies an ends-with text rule.

Parameters

text System.String requiredposition: 0
EndsWithText 2 overloads
public ExcelRange EndsWithText(String text) #
Returns: ExcelRange

Applies an ends-with-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange EndsWithText(String text, String fillColor) #
Returns: ExcelRange

Applies an ends-with-text rule with an optional solid fill.

Parameters

text System.String requiredposition: 0
fillColor System.String requiredposition: 1
public ExcelRange Errors() #
Returns: ExcelRange

Applies an errors rule.

Formula 3 overloads
public ExcelRange Formula(String formula) #
Returns: ExcelRange

Applies a formula-based rule.

Parameters

formula System.String requiredposition: 0
public ExcelRange Formula(String formula, Boolean stopIfTrue) #
Returns: ExcelRange

Applies a formula-based rule.

Parameters

formula System.String requiredposition: 0
stopIfTrue System.Boolean requiredposition: 1
public ExcelRange Formula(String formula, Boolean stopIfTrue = false, String fillColor = null) #
Returns: ExcelRange

Applies a formula-based rule.

Parameters

formula System.String requiredposition: 0
stopIfTrue System.Boolean = false optionalposition: 1
fillColor System.String = null optionalposition: 2
GreaterThan 2 overloads
public ExcelRange GreaterThan(String formula) #
Returns: ExcelRange

Applies a greater-than cell-value rule.

Parameters

formula System.String requiredposition: 0
public ExcelRange GreaterThan(String formula, String fillColor) #
Returns: ExcelRange

Applies a greater-than cell-value rule.

Parameters

formula System.String requiredposition: 0
fillColor System.String requiredposition: 1
IconSet 2 overloads
public ExcelRange IconSet() #
Returns: ExcelRange

Applies an icon set.

public ExcelRange IconSet(IconSetValues iconSet, Boolean showValue = true, Boolean reverseIconOrder = false, Double[] percentThresholds = null, Double[] numberThresholds = null) #
Returns: ExcelRange

Applies an icon set.

Parameters

iconSet DocumentFormat.OpenXml.Spreadsheet.IconSetValues requiredposition: 0
showValue System.Boolean = true optionalposition: 1
reverseIconOrder System.Boolean = false optionalposition: 2
percentThresholds System.Double[] = null optionalposition: 3
numberThresholds System.Double[] = null optionalposition: 4
LessThan 2 overloads
public ExcelRange LessThan(String formula) #
Returns: ExcelRange

Applies a less-than cell-value rule.

Parameters

formula System.String requiredposition: 0
public ExcelRange LessThan(String formula, String fillColor) #
Returns: ExcelRange

Applies a less-than cell-value rule.

Parameters

formula System.String requiredposition: 0
fillColor System.String requiredposition: 1
public ExcelRange NonBlanks() #
Returns: ExcelRange

Applies a non-blanks rule.

public ExcelRange NonErrors() #
Returns: ExcelRange

Applies a non-errors rule.

NotContainsText 2 overloads
public ExcelRange NotContainsText(String text) #
Returns: ExcelRange

Applies a not-contains-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange NotContainsText(String text, String fillColor) #
Returns: ExcelRange

Applies a not-contains-text rule with an optional solid fill.

Parameters

text System.String requiredposition: 0
fillColor System.String requiredposition: 1
TimePeriod 2 overloads
public ExcelRange TimePeriod(TimePeriodValues timePeriod) #
Returns: ExcelRange

Applies a time-period rule.

Parameters

timePeriod DocumentFormat.OpenXml.Spreadsheet.TimePeriodValues requiredposition: 0
public ExcelRange TimePeriod(TimePeriodValues timePeriod, String fillColor) #
Returns: ExcelRange

Applies a time-period rule with a differential fill color.

Parameters

timePeriod DocumentFormat.OpenXml.Spreadsheet.TimePeriodValues requiredposition: 0
fillColor System.String requiredposition: 1
Top 2 overloads
public ExcelRange Top(UInt32 rank, Boolean percent = false) #
Returns: ExcelRange

Applies a top-values rule.

Parameters

rank System.UInt32 requiredposition: 0
percent System.Boolean = false optionalposition: 1
public ExcelRange Top(UInt32 rank, String fillColor, Boolean percent = false) #
Returns: ExcelRange

Applies a top-values rule with an optional solid fill.

Parameters

rank System.UInt32 requiredposition: 0
fillColor System.String requiredposition: 1
percent System.Boolean = false optionalposition: 2
UniqueValues 2 overloads
public ExcelRange UniqueValues() #
Returns: ExcelRange

Applies a unique-values rule.

public ExcelRange UniqueValues(String fillColor) #
Returns: ExcelRange

Applies a unique-values rule with an optional solid fill.

Parameters

fillColor System.String requiredposition: 0