Class ConditionalFormattingCollection

Represents the collection of conditional formattings on a worksheet.

Inheritance

System.Object

ConditionalFormattingCollection

Namespace: DRIT.Spreadsheet.ConditionalFormatting

Assembly: DRIT.Spreadsheet.dll

Syntax

public class ConditionalFormattingCollection : IEnumerable<ConditionalFormatting>

Properties

Count

Declaration

public int Count { get; }

Property Value

Type	Description
System.Int32

Methods

Add(ConditionalFormatting)

Declaration

public void Add(ConditionalFormatting item)

Parameters

Type	Name	Description
ConditionalFormatting	item

Add(String)

Declaration

public ConditionalFormatting Add(string range)

Parameters

Type	Name	Description
System.String	range

Returns

Type	Description
ConditionalFormatting

Add(String, ConditionalFormattingRule[])

Declaration

public void Add(string range, params ConditionalFormattingRule[] rules)

Parameters

Type	Name	Description
System.String	range
ConditionalFormattingRule[]	rules

AddAboveAverage(String, Boolean)

Declaration

public AboveAverageFormattingRule AddAboveAverage(string range, bool aboveAverage)

Parameters

Type	Name	Description
System.String	range
System.Boolean	aboveAverage

Returns

Type	Description
AboveAverageFormattingRule

AddCellValue(String, ConditionalFormattingOperator, Double[])

Declaration

public CellIsFormattingRule AddCellValue(string range, ConditionalFormattingOperator conditionalFormattingOperator, params double[] values)

Parameters

Type	Name	Description
System.String	range
ConditionalFormattingOperator	conditionalFormattingOperator
System.Double[]	values

Returns

Type	Description
CellIsFormattingRule

AddDataBar(String, SpreadsheetColor)

Declaration

public DataBarFormattingRule AddDataBar(string range, SpreadsheetColor color)

Parameters

Type	Name	Description
System.String	range
SpreadsheetColor	color

Returns

Type	Description
DataBarFormattingRule

AddDatesOccurring(String, TimePeriod)

Declaration

public DatesOccurringFormattingRule AddDatesOccurring(string range, TimePeriod timePeriod)

Parameters

Type	Name	Description
System.String	range
TimePeriod	timePeriod

Returns

Type	Description
DatesOccurringFormattingRule

AddDuplicateValues(String)

Declaration

public DuplicateValuesFormattingRule AddDuplicateValues(string range)

Parameters

Type	Name	Description
System.String	range

Returns

Type	Description
DuplicateValuesFormattingRule

AddExpression(String, String)

Declaration

public ExpressionFormattingRule AddExpression(string range, string formula)

Parameters

Type	Name	Description
System.String	range
System.String	formula

Returns

Type	Description
ExpressionFormattingRule

AddIconSet(String, IconSetType)

Declaration

public IconSetFormattingRule AddIconSet(string range, IconSetType type)

Parameters

Type	Name	Description
System.String	range
IconSetType	type

Returns

Type	Description
IconSetFormattingRule

AddSpecificText(String, SpecificTextFormattingRuleType, String)

Declaration

public SpecificTextFormattingRule AddSpecificText(string range, SpecificTextFormattingRuleType textOperator, string value)

Parameters

Type	Name	Description
System.String	range
SpecificTextFormattingRuleType	textOperator
System.String	value

Returns

Type	Description
SpecificTextFormattingRule

AddThreeColorScale(String, SpreadsheetColor, SpreadsheetColor, SpreadsheetColor)

Declaration

public ThreeColorScaleFormattingRule AddThreeColorScale(string range, SpreadsheetColor minColor, SpreadsheetColor midColor, SpreadsheetColor maxColor)

Parameters

Type	Name	Description
System.String	range
SpreadsheetColor	minColor
SpreadsheetColor	midColor
SpreadsheetColor	maxColor

Returns

Type	Description
ThreeColorScaleFormattingRule

AddTop10(String, Int32)

Declaration

public Top10FormattingRule AddTop10(string range, int rank)

Parameters

Type	Name	Description
System.String	range
System.Int32	rank

Returns

Type	Description
Top10FormattingRule

AddTwoColorScale(String, SpreadsheetColor, SpreadsheetColor)

Declaration

public TwoColorScaleFormattingRule AddTwoColorScale(string range, SpreadsheetColor minColor, SpreadsheetColor maxColor)

Parameters

Type	Name	Description
System.String	range
SpreadsheetColor	minColor
SpreadsheetColor	maxColor

Returns

Type	Description
TwoColorScaleFormattingRule

AddUniqueValues(String)

Declaration

public UniqueValuesFormattingRule AddUniqueValues(string range)

Parameters

Type	Name	Description
System.String	range

Returns

Type	Description
UniqueValuesFormattingRule

Clear()

Declaration

public void Clear()

ClearRules(Range)

Declaration

public void ClearRules(Range range)

Parameters

Type	Name	Description
Range	range

Contains(ConditionalFormatting)

Declaration

public bool Contains(ConditionalFormatting item)

Parameters

Type	Name	Description
ConditionalFormatting	item

Returns

Type	Description
System.Boolean

Get(String)

Declaration

public ConditionalFormatting Get(string label)

Parameters

Type	Name	Description
System.String	label

Returns

Type	Description
ConditionalFormatting

GetEnumerator()

Declaration

public IEnumerator<ConditionalFormatting> GetEnumerator()

Returns

Type	Description
IEnumerator<ConditionalFormatting>

Remove(ConditionalFormatting)

Declaration

public void Remove(ConditionalFormatting item)

Parameters

Type	Name	Description
ConditionalFormatting	item