Skip to main content
SearchCtrl K
Community

Source code

OfficeIMO.NET libraries, CLI, Studio and browser tools 573 stars PSWriteOfficePowerShell module 165 stars

Talk and help

DiscordQuestions, ideas and show and tell Report an issueBugs and feature requests SponsorFund ongoing development

Mode

Background

Search OfficeIMO

Enter a topic, API type, or PowerShell command.

Search the whole siteOpen search page →
Documentation Search all OfficeIMO/

API Reference

Class

ExcelRangeConditionalFormattingBuilder

Edit on GitHub
Namespace OfficeIMO.Excel
Assembly OfficeIMO.Excel
Source ExcelRangeConditionalFormattingBuilder.cs:19
Modifiers sealed

Fluent conditional formatting builder for an ExcelRange.

Inheritance

  • Object
  • ExcelRangeConditionalFormattingBuilder

Usage

Explore 2 API references to this type

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

Returned or exposed by 2

Methods

AboveAverage 3 overloads
public ExcelRange AboveAverage() #
ExcelRangeConditionalFormattingBuilder.cs:195
Returns: ExcelRange

Applies an above-average rule.

public ExcelRange AboveAverage(String? fillColor, Boolean equalAverage = false) #
ExcelRangeConditionalFormattingBuilder.cs:202
Returns: ExcelRange

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

Parameters

fillColor System.String? requiredposition: 0
equalAverage System.Boolean = false optionalposition: 1
public ExcelRange AboveAverage(Boolean equalAverage = false, UInt32? standardDeviation = null) #
ExcelRangeConditionalFormattingBuilder.cs:255
Returns: ExcelRange

Applies an above-average rule.

Parameters

equalAverage System.Boolean = false optionalposition: 0
standardDeviation System.UInt32? = null optionalposition: 1
public ExcelRange BeginsWith(String text) #
ExcelRangeConditionalFormattingBuilder.cs:271
Returns: ExcelRange

Applies a begins-with text rule.

Parameters

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

Applies a begins-with-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange BeginsWithText(String text, String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:142
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() #
ExcelRangeConditionalFormattingBuilder.cs:210
Returns: ExcelRange

Applies a below-average rule.

public ExcelRange BelowAverage(String? fillColor, Boolean equalAverage = false) #
ExcelRangeConditionalFormattingBuilder.cs:217
Returns: ExcelRange

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

Parameters

fillColor System.String? requiredposition: 0
equalAverage System.Boolean = false optionalposition: 1
public ExcelRange BelowAverage(Boolean equalAverage = false, UInt32? standardDeviation = null) #
ExcelRangeConditionalFormattingBuilder.cs:263
Returns: ExcelRange

Applies a below-average rule.

Parameters

equalAverage System.Boolean = false optionalposition: 0
standardDeviation System.UInt32? = null optionalposition: 1
Between 2 overloads
public ExcelRange Between(String formula1, String formula2) #
ExcelRangeConditionalFormattingBuilder.cs:69
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) #
ExcelRangeConditionalFormattingBuilder.cs:76
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() #
ExcelRangeConditionalFormattingBuilder.cs:287
Returns: ExcelRange

Applies a blanks rule.

Bottom 2 overloads
public ExcelRange Bottom(UInt32 rank, Boolean percent = false) #
ExcelRangeConditionalFormattingBuilder.cs:240
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) #
ExcelRangeConditionalFormattingBuilder.cs:247
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(ExcelConditionalFormattingOperator operator, String formula1) #
ExcelRangeConditionalFormattingBuilder.cs:19
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator OfficeIMO.Excel.ExcelConditionalFormattingOperator requiredposition: 0
formula1 System.String requiredposition: 1
public ExcelRange CellIs(ExcelConditionalFormattingOperator operator, String formula1, String? formula2) #
ExcelRangeConditionalFormattingBuilder.cs:26
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator OfficeIMO.Excel.ExcelConditionalFormattingOperator requiredposition: 0
formula1 System.String requiredposition: 1
formula2 System.String? requiredposition: 2
public ExcelRange CellIs(ExcelConditionalFormattingOperator operator, String formula1, String? formula2 = null, String? fillColor = null) #
ExcelRangeConditionalFormattingBuilder.cs:33
Returns: ExcelRange

Applies a cell-value comparison rule.

Parameters

operator OfficeIMO.Excel.ExcelConditionalFormattingOperator requiredposition: 0
formula1 System.String requiredposition: 1
formula2 System.String? = null optionalposition: 2
fillColor System.String? = null optionalposition: 3
public ExcelRange Clear() #
ExcelRangeConditionalFormattingBuilder.cs:382
Returns: ExcelRange

Removes conditional formatting rules that overlap the range.

ColorScale 2 overloads
public ExcelRange ColorScale(OfficeColor startColor, OfficeColor endColor) #
ExcelRangeConditionalFormattingBuilder.cs:335
Returns: ExcelRange

Applies a two-color scale.

Parameters

startColor OfficeIMO.Drawing.OfficeColor requiredposition: 0
endColor OfficeIMO.Drawing.OfficeColor requiredposition: 1
public ExcelRange ColorScale(String startColor, String endColor) #
ExcelRangeConditionalFormattingBuilder.cs:343
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) #
ExcelRangeConditionalFormattingBuilder.cs:105
Returns: ExcelRange

Applies a contains-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange ContainsText(String text, String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:112
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) #
ExcelRangeConditionalFormattingBuilder.cs:351
Returns: ExcelRange

Applies a data bar.

Parameters

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

Applies a data bar using a hex color.

Parameters

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

Applies a duplicate-values rule.

public ExcelRange DuplicateValues(String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:172
Returns: ExcelRange

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

Parameters

fillColor System.String? requiredposition: 0
public ExcelRange EndsWith(String text) #
ExcelRangeConditionalFormattingBuilder.cs:279
Returns: ExcelRange

Applies an ends-with text rule.

Parameters

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

Applies an ends-with-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange EndsWithText(String text, String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:157
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() #
ExcelRangeConditionalFormattingBuilder.cs:303
Returns: ExcelRange

Applies an errors rule.

Formula 3 overloads
public ExcelRange Formula(String formula) #
ExcelRangeConditionalFormattingBuilder.cs:83
Returns: ExcelRange

Applies a formula-based rule.

Parameters

formula System.String requiredposition: 0
public ExcelRange Formula(String formula, Boolean stopIfTrue) #
ExcelRangeConditionalFormattingBuilder.cs:90
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) #
ExcelRangeConditionalFormattingBuilder.cs:97
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) #
ExcelRangeConditionalFormattingBuilder.cs:41
Returns: ExcelRange

Applies a greater-than cell-value rule.

Parameters

formula System.String requiredposition: 0
public ExcelRange GreaterThan(String formula, String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:48
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() #
ExcelRangeConditionalFormattingBuilder.cs:367
Returns: ExcelRange

Applies an icon set.

public ExcelRange IconSet(ExcelIconSet iconSet, Boolean showValue = true, Boolean reverseIconOrder = false, Double[]? percentThresholds = null, Double[]? numberThresholds = null) #
ExcelRangeConditionalFormattingBuilder.cs:374
Returns: ExcelRange

Applies an icon set.

Parameters

iconSet OfficeIMO.Excel.ExcelIconSet 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) #
ExcelRangeConditionalFormattingBuilder.cs:55
Returns: ExcelRange

Applies a less-than cell-value rule.

Parameters

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

Applies a less-than cell-value rule.

Parameters

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

Applies a non-blanks rule.

public ExcelRange NonErrors() #
ExcelRangeConditionalFormattingBuilder.cs:311
Returns: ExcelRange

Applies a non-errors rule.

NotContainsText 2 overloads
public ExcelRange NotContainsText(String text) #
ExcelRangeConditionalFormattingBuilder.cs:120
Returns: ExcelRange

Applies a not-contains-text rule.

Parameters

text System.String requiredposition: 0
public ExcelRange NotContainsText(String text, String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:127
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(ExcelConditionalTimePeriod timePeriod) #
ExcelRangeConditionalFormattingBuilder.cs:319
Returns: ExcelRange

Applies a time-period rule.

Parameters

timePeriod OfficeIMO.Excel.ExcelConditionalTimePeriod requiredposition: 0
public ExcelRange TimePeriod(ExcelConditionalTimePeriod timePeriod, String fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:327
Returns: ExcelRange

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

Parameters

timePeriod OfficeIMO.Excel.ExcelConditionalTimePeriod requiredposition: 0
fillColor System.String requiredposition: 1
Top 2 overloads
public ExcelRange Top(UInt32 rank, Boolean percent = false) #
ExcelRangeConditionalFormattingBuilder.cs:225
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) #
ExcelRangeConditionalFormattingBuilder.cs:232
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() #
ExcelRangeConditionalFormattingBuilder.cs:180
Returns: ExcelRange

Applies a unique-values rule.

public ExcelRange UniqueValues(String? fillColor) #
ExcelRangeConditionalFormattingBuilder.cs:187
Returns: ExcelRange

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

Parameters

fillColor System.String? requiredposition: 0