Table of Contents

Class ExcelConditionalFormattingCollection

Namespace
OfficeOpenXml.ConditionalFormatting
Assembly
EPPlus.dll

Collection of all ConditionalFormattings in the workbook

public class ExcelConditionalFormattingCollection : IEnumerable<IExcelConditionalFormattingRule>, IEnumerable
Inheritance
ExcelConditionalFormattingCollection
Implements
Inherited Members

Properties

Count

Number of validations

public int Count { get; }

Property Value

int

this[int]

Index operator, returns by 0-based index

public ExcelConditionalFormattingRule this[int index] { get; set; }

Parameters

index int

Property Value

ExcelConditionalFormattingRule

Methods

AddAboveAverage(ExcelAddress)

Add AboveAverage Rule

public IExcelConditionalFormattingAverageGroup AddAboveAverage(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingAverageGroup

AddAboveAverage(string)

Add AboveAverage Rule

public IExcelConditionalFormattingAverageGroup AddAboveAverage(string address)

Parameters

address string

String must be a valid excelAddress

Returns

IExcelConditionalFormattingAverageGroup

AddAboveOrEqualAverage(ExcelAddress)

Add AboveOrEqualAverage Rule

public IExcelConditionalFormattingAverageGroup AddAboveOrEqualAverage(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingAverageGroup

AddAboveOrEqualAverage(string)

Add AboveOrEqualAverage Rule

public IExcelConditionalFormattingAverageGroup AddAboveOrEqualAverage(string address)

Parameters

address string

Returns

IExcelConditionalFormattingAverageGroup

AddAboveStdDev(ExcelAddress)

Add AboveStdDev Rule

public IExcelConditionalFormattingStdDevGroup AddAboveStdDev(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingStdDevGroup

AddAboveStdDev(string)

Add AboveStdDev Rule

public IExcelConditionalFormattingStdDevGroup AddAboveStdDev(string address)

Parameters

address string

Returns

IExcelConditionalFormattingStdDevGroup

AddBeginsWith(ExcelAddress)

Add BeginsWith Rule

public IExcelConditionalFormattingBeginsWith AddBeginsWith(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingBeginsWith

AddBeginsWith(string)

Add BeginsWith Rule

public IExcelConditionalFormattingBeginsWith AddBeginsWith(string address)

Parameters

address string

Returns

IExcelConditionalFormattingBeginsWith

AddBelowAverage(ExcelAddress)

Add BelowAverage Rule

public IExcelConditionalFormattingAverageGroup AddBelowAverage(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingAverageGroup

AddBelowAverage(string)

Add BelowAverage Rule

public IExcelConditionalFormattingAverageGroup AddBelowAverage(string address)

Parameters

address string

Returns

IExcelConditionalFormattingAverageGroup

AddBelowOrEqualAverage(ExcelAddress)

Add BelowOrEqualAverage Rule

public IExcelConditionalFormattingAverageGroup AddBelowOrEqualAverage(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingAverageGroup

AddBelowOrEqualAverage(string)

Add BelowOrEqualAverage Rule

public IExcelConditionalFormattingAverageGroup AddBelowOrEqualAverage(string address)

Parameters

address string

Returns

IExcelConditionalFormattingAverageGroup

AddBelowStdDev(ExcelAddress)

Add BelowStdDev Rule

public IExcelConditionalFormattingStdDevGroup AddBelowStdDev(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingStdDevGroup

AddBelowStdDev(string)

Add BelowStdDev Rule

public IExcelConditionalFormattingStdDevGroup AddBelowStdDev(string address)

Parameters

address string

Returns

IExcelConditionalFormattingStdDevGroup

AddBetween(ExcelAddress)

Add between rule

public IExcelConditionalFormattingBetween AddBetween(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingBetween

AddBetween(string)

Add between rule

public IExcelConditionalFormattingBetween AddBetween(string address)

Parameters

address string

Returns

IExcelConditionalFormattingBetween

AddBottom(ExcelAddress)

Add Bottom Rule

public IExcelConditionalFormattingTopBottomGroup AddBottom(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTopBottomGroup

AddBottom(string)

Add Bottom Rule

public IExcelConditionalFormattingTopBottomGroup AddBottom(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTopBottomGroup

AddBottomPercent(ExcelAddress)

Add BottomPercent Rule

public IExcelConditionalFormattingTopBottomGroup AddBottomPercent(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTopBottomGroup

AddBottomPercent(string)

Add BottomPercent Rule

public IExcelConditionalFormattingTopBottomGroup AddBottomPercent(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTopBottomGroup

AddContainsBlanks(ExcelAddress)

Add ContainsBlanks Rule

public IExcelConditionalFormattingContainsBlanks AddContainsBlanks(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingContainsBlanks

AddContainsBlanks(string)

Add ContainsBlanks Rule

public IExcelConditionalFormattingContainsBlanks AddContainsBlanks(string address)

Parameters

address string

Returns

IExcelConditionalFormattingContainsBlanks

AddContainsErrors(ExcelAddress)

Add ContainsErrors Rule

public IExcelConditionalFormattingContainsErrors AddContainsErrors(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingContainsErrors

AddContainsErrors(string)

Add ContainsErrors Rule

public IExcelConditionalFormattingContainsErrors AddContainsErrors(string address)

Parameters

address string

Returns

IExcelConditionalFormattingContainsErrors

AddContainsText(ExcelAddress)

Add ContainsText Rule

public IExcelConditionalFormattingContainsText AddContainsText(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingContainsText

AddContainsText(string)

Add ContainsText Rule

public IExcelConditionalFormattingContainsText AddContainsText(string address)

Parameters

address string

Returns

IExcelConditionalFormattingContainsText

AddDatabar(ExcelAddress, Color)

Adds a databar rule

public IExcelConditionalFormattingDataBarGroup AddDatabar(ExcelAddress Address, Color color)

Parameters

Address ExcelAddress
color Color

Returns

IExcelConditionalFormattingDataBarGroup

AddDatabar(string, Color)

Adds a databar rule

public IExcelConditionalFormattingDataBarGroup AddDatabar(string Address, Color color)

Parameters

Address string
color Color

Returns

IExcelConditionalFormattingDataBarGroup

AddDuplicateValues(ExcelAddress)

Add DuplicateValues Rule

public IExcelConditionalFormattingDuplicateValues AddDuplicateValues(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingDuplicateValues

AddDuplicateValues(string)

Add DuplicateValues Rule

public IExcelConditionalFormattingDuplicateValues AddDuplicateValues(string address)

Parameters

address string

Returns

IExcelConditionalFormattingDuplicateValues

AddEndsWith(ExcelAddress)

Add EndsWith Rule

public IExcelConditionalFormattingEndsWith AddEndsWith(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingEndsWith

AddEndsWith(string)

Add EndsWith Rule

public IExcelConditionalFormattingEndsWith AddEndsWith(string address)

Parameters

address string

Returns

IExcelConditionalFormattingEndsWith

AddEqual(ExcelAddress)

Add Equal rule

public IExcelConditionalFormattingEqual AddEqual(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingEqual

AddEqual(string)

Add Equal rule

public IExcelConditionalFormattingEqual AddEqual(string address)

Parameters

address string

Returns

IExcelConditionalFormattingEqual

AddExpression(ExcelAddress)

Add Expression Rule

public IExcelConditionalFormattingExpression AddExpression(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingExpression

AddExpression(string)

Add Expression Rule

public IExcelConditionalFormattingExpression AddExpression(string address)

Parameters

address string

Returns

IExcelConditionalFormattingExpression

AddFiveIconSet(ExcelAddress, eExcelconditionalFormatting5IconsSetType)

Adds a FiveIconSet rule

public IExcelConditionalFormattingFiveIconSet AddFiveIconSet(ExcelAddress Address, eExcelconditionalFormatting5IconsSetType IconSet)

Parameters

Address ExcelAddress
IconSet eExcelconditionalFormatting5IconsSetType

Returns

IExcelConditionalFormattingFiveIconSet

AddFiveIconSet(string, eExcelconditionalFormatting5IconsSetType)

Adds a FiveIconSet rule

public IExcelConditionalFormattingFiveIconSet AddFiveIconSet(string Address, eExcelconditionalFormatting5IconsSetType IconSet)

Parameters

Address string
IconSet eExcelconditionalFormatting5IconsSetType

Returns

IExcelConditionalFormattingFiveIconSet

AddFourIconSet(ExcelAddress, eExcelconditionalFormatting4IconsSetType)

Adds a FourIconSet rule

public IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType> AddFourIconSet(ExcelAddress Address, eExcelconditionalFormatting4IconsSetType IconSet)

Parameters

Address ExcelAddress
IconSet eExcelconditionalFormatting4IconsSetType

Returns

IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType>

AddFourIconSet(string, eExcelconditionalFormatting4IconsSetType)

Adds a FourIconSet rule

public IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType> AddFourIconSet(string Address, eExcelconditionalFormatting4IconsSetType IconSet)

Parameters

Address string
IconSet eExcelconditionalFormatting4IconsSetType

Returns

IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType>

AddGreaterThan(ExcelAddress)

Add GreaterThan Rule

public IExcelConditionalFormattingGreaterThan AddGreaterThan(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingGreaterThan

AddGreaterThan(string)

Add GreaterThan Rule

public IExcelConditionalFormattingGreaterThan AddGreaterThan(string address)

Parameters

address string

Returns

IExcelConditionalFormattingGreaterThan

AddGreaterThanOrEqual(ExcelAddress)

Add GreaterThanOrEqual Rule

public IExcelConditionalFormattingGreaterThanOrEqual AddGreaterThanOrEqual(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingGreaterThanOrEqual

AddGreaterThanOrEqual(string)

Add GreaterThanOrEqual Rule

public IExcelConditionalFormattingGreaterThanOrEqual AddGreaterThanOrEqual(string address)

Parameters

address string

Returns

IExcelConditionalFormattingGreaterThanOrEqual

AddLast7Days(ExcelAddress)

Add Last7Days rule

public IExcelConditionalFormattingTimePeriodGroup AddLast7Days(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLast7Days(string)

Add Last7Days rule

public IExcelConditionalFormattingTimePeriodGroup AddLast7Days(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLastMonth(ExcelAddress)

Add last month rule

public IExcelConditionalFormattingTimePeriodGroup AddLastMonth(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLastMonth(string)

Add last month rule

public IExcelConditionalFormattingTimePeriodGroup AddLastMonth(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLastWeek(ExcelAddress)

Add lastWeek rule

public IExcelConditionalFormattingTimePeriodGroup AddLastWeek(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLastWeek(string)

Add lastWeek rule

public IExcelConditionalFormattingTimePeriodGroup AddLastWeek(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddLessThan(ExcelAddress)

Add LessThan Rule

public IExcelConditionalFormattingLessThan AddLessThan(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingLessThan

AddLessThan(string)

Add LessThan Rule

public IExcelConditionalFormattingLessThan AddLessThan(string address)

Parameters

address string

Returns

IExcelConditionalFormattingLessThan

AddLessThanOrEqual(ExcelAddress)

Add LessThanOrEqual Rule

public IExcelConditionalFormattingLessThanOrEqual AddLessThanOrEqual(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingLessThanOrEqual

AddLessThanOrEqual(string)

Add LessThanOrEqual Rule

public IExcelConditionalFormattingLessThanOrEqual AddLessThanOrEqual(string address)

Parameters

address string

Returns

IExcelConditionalFormattingLessThanOrEqual

AddNextMonth(ExcelAddress)

Add NextMonth rule

public IExcelConditionalFormattingTimePeriodGroup AddNextMonth(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddNextMonth(string)

Add NextMonth rule

public IExcelConditionalFormattingTimePeriodGroup AddNextMonth(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddNextWeek(ExcelAddress)

Add next week rule

public IExcelConditionalFormattingTimePeriodGroup AddNextWeek(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddNextWeek(string)

Add next week rule

public IExcelConditionalFormattingTimePeriodGroup AddNextWeek(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddNotBetween(ExcelAddress)

Add NotBetween Rule

public IExcelConditionalFormattingNotBetween AddNotBetween(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingNotBetween

AddNotBetween(string)

Add NotBetween Rule

public IExcelConditionalFormattingNotBetween AddNotBetween(string address)

Parameters

address string

Returns

IExcelConditionalFormattingNotBetween

AddNotContainsBlanks(ExcelAddress)

Add NotContainsBlanks Rule

public IExcelConditionalFormattingNotContainsBlanks AddNotContainsBlanks(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingNotContainsBlanks

AddNotContainsBlanks(string)

Add NotContainsBlanks Rule

public IExcelConditionalFormattingNotContainsBlanks AddNotContainsBlanks(string address)

Parameters

address string

Returns

IExcelConditionalFormattingNotContainsBlanks

AddNotContainsErrors(ExcelAddress)

Add NotContainsErrors Rule

public IExcelConditionalFormattingNotContainsErrors AddNotContainsErrors(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingNotContainsErrors

AddNotContainsErrors(string)

Add NotContainsErrors Rule

public IExcelConditionalFormattingNotContainsErrors AddNotContainsErrors(string address)

Parameters

address string

Returns

IExcelConditionalFormattingNotContainsErrors

AddNotContainsText(ExcelAddress)

Add NotContainsText Rule

public IExcelConditionalFormattingNotContainsText AddNotContainsText(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingNotContainsText

AddNotContainsText(string)

Add NotContainsText Rule

public IExcelConditionalFormattingNotContainsText AddNotContainsText(string address)

Parameters

address string

Returns

IExcelConditionalFormattingNotContainsText

AddNotEqual(ExcelAddress)

Add NotEqual Rule

public IExcelConditionalFormattingNotEqual AddNotEqual(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingNotEqual

AddNotEqual(string)

Add NotEqual Rule

public IExcelConditionalFormattingNotEqual AddNotEqual(string address)

Parameters

address string

Returns

IExcelConditionalFormattingNotEqual

AddTextContains(ExcelAddress)

Add TextContains rule

public IExcelConditionalFormattingContainsText AddTextContains(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingContainsText

AddTextContains(string)

Add TextContains rule

public IExcelConditionalFormattingContainsText AddTextContains(string address)

Parameters

address string

Returns

IExcelConditionalFormattingContainsText

AddThisMonth(ExcelAddress)

Add ThisMonth rule

public IExcelConditionalFormattingTimePeriodGroup AddThisMonth(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddThisMonth(string)

Add ThisMonth rule

public IExcelConditionalFormattingTimePeriodGroup AddThisMonth(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddThisWeek(ExcelAddress)

Add this week rule

public IExcelConditionalFormattingTimePeriodGroup AddThisWeek(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddThisWeek(string)

Add this week rule

public IExcelConditionalFormattingTimePeriodGroup AddThisWeek(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddThreeColorScale(ExcelAddress)

Add ThreeColorScale Rule

public IExcelConditionalFormattingThreeColorScale AddThreeColorScale(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingThreeColorScale

AddThreeColorScale(string)

Add ThreeColorScale Rule

public IExcelConditionalFormattingThreeColorScale AddThreeColorScale(string address)

Parameters

address string

Returns

IExcelConditionalFormattingThreeColorScale

AddThreeIconSet(ExcelAddress, eExcelconditionalFormatting3IconsSetType)

Add ThreeIconSet Rule

public IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType> AddThreeIconSet(ExcelAddress Address, eExcelconditionalFormatting3IconsSetType IconSet)

Parameters

Address ExcelAddress

The address

IconSet eExcelconditionalFormatting3IconsSetType

Type of iconset

Returns

IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType>

AddThreeIconSet(string, eExcelconditionalFormatting3IconsSetType)

Add ThreeIconSet Rule

public IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType> AddThreeIconSet(string Address, eExcelconditionalFormatting3IconsSetType IconSet)

Parameters

Address string

The address

IconSet eExcelconditionalFormatting3IconsSetType

Type of iconset

Returns

IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType>

AddToday(ExcelAddress)

Add Today rule

public IExcelConditionalFormattingTimePeriodGroup AddToday(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddToday(string)

Add Today rule

public IExcelConditionalFormattingTimePeriodGroup AddToday(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddTomorrow(ExcelAddress)

Add Tomorrow rule

public IExcelConditionalFormattingTimePeriodGroup AddTomorrow(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddTomorrow(string)

Add Tomorrow rule

public IExcelConditionalFormattingTimePeriodGroup AddTomorrow(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

AddTop(ExcelAddress)

Add Top Rule

public IExcelConditionalFormattingTopBottomGroup AddTop(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTopBottomGroup

AddTop(string)

Add Top Rule

public IExcelConditionalFormattingTopBottomGroup AddTop(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTopBottomGroup

AddTopPercent(ExcelAddress)

Add TopPercent Rule

public IExcelConditionalFormattingTopBottomGroup AddTopPercent(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTopBottomGroup

AddTopPercent(string)

Add TopPercent Rule

public IExcelConditionalFormattingTopBottomGroup AddTopPercent(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTopBottomGroup

AddTwoColorScale(ExcelAddress)

Add TwoColorScale Rule

public IExcelConditionalFormattingTwoColorScale AddTwoColorScale(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTwoColorScale

AddTwoColorScale(string)

Add TwoColorScale Rule

public IExcelConditionalFormattingTwoColorScale AddTwoColorScale(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTwoColorScale

AddUniqueValues(ExcelAddress)

Add Unique Rule

public IExcelConditionalFormattingUniqueValues AddUniqueValues(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingUniqueValues

AddUniqueValues(string)

Add Unique Rule

public IExcelConditionalFormattingUniqueValues AddUniqueValues(string address)

Parameters

address string

Returns

IExcelConditionalFormattingUniqueValues

AddYesterday(ExcelAddress)

Add Yesterday rule

public IExcelConditionalFormattingTimePeriodGroup AddYesterday(ExcelAddress address)

Parameters

address ExcelAddress

Returns

IExcelConditionalFormattingTimePeriodGroup

AddYesterday(string)

Add Yesterday rule

public IExcelConditionalFormattingTimePeriodGroup AddYesterday(string address)

Parameters

address string

Returns

IExcelConditionalFormattingTimePeriodGroup

Remove(IExcelConditionalFormattingRule)

Remove a Conditional Formatting Rule by its object

public void Remove(IExcelConditionalFormattingRule item)

Parameters

item IExcelConditionalFormattingRule

RemoveAll()

Removes all 'cfRule' from the collection and from the XML. This is the same as removing all the 'conditionalFormatting' nodes. 

public void RemoveAll()

RemoveAt(int)

Remove a Conditional Formatting Rule by its 0-based index

public void RemoveAt(int index)

Parameters

index int

RemoveByPriority(int)

Remove a Conditional Formatting Rule by its priority

public void RemoveByPriority(int priority)

Parameters

priority int

RulesByPriority(int)

Get a rule by its priority

public IExcelConditionalFormattingRule RulesByPriority(int priority)

Parameters

priority int

Returns

IExcelConditionalFormattingRule