Class ConditionalFormattingRule

Namespace

Openize.Cells

Assembly

Openize.OpenXMLSDK.dll

Represents a conditional formatting rule.

public class ConditionalFormattingRule

Inheritance

object

ConditionalFormattingRule

Inherited Members

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Constructors

ConditionalFormattingRule()

Initializes a new instance of the ConditionalFormattingRule class.

public ConditionalFormattingRule()

Properties

CellRange

Gets or sets the cell range(s) to apply the formatting to

public string CellRange { get; set; }

Property Value

string

ColorScale

Gets or sets the color scale options

public ColorScaleOptions ColorScale { get; set; }

Property Value

ColorScaleOptions

DataBar

Gets or sets the data bar options

public DataBarOptions DataBar { get; set; }

Property Value

DataBarOptions

Operator

Gets or sets the operator for comparison

public ConditionalFormattingOperator? Operator { get; set; }

Property Value

ConditionalFormattingOperator?

Priority

Gets or sets the priority of the rule

public uint Priority { get; }

Property Value

uint

StopIfTrue

Gets or sets whether to stop if this rule is true

public bool StopIfTrue { get; set; }

Property Value

bool

Style

Gets or sets the style to apply when condition is met

public ConditionalFormattingStyle Style { get; set; }

Property Value

ConditionalFormattingStyle

Type

Gets or sets the type of conditional formatting

public ConditionalFormattingType Type { get; set; }

Property Value

ConditionalFormattingType

Value1

Gets or sets the first value or formula for comparison

public string Value1 { get; set; }

Property Value

string

Value2

Gets or sets the second value for between/not between operators

public string Value2 { get; set; }

Property Value

string

Methods

AboveAverage(bool, ConditionalFormattingStyle)

Creates a rule for highlighting above average values.

public static ConditionalFormattingRule AboveAverage(bool isAbove, ConditionalFormattingStyle style)

Parameters

isAbove bool

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

Between(string, string, ConditionalFormattingStyle)

Creates a rule for highlighting cells between two values.

public static ConditionalFormattingRule Between(string value1, string value2, ConditionalFormattingStyle style)

Parameters

value1 string

value2 string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

ColorScaleRule(ColorScaleOptions)

Creates a rule for color scale visualization.

public static ConditionalFormattingRule ColorScaleRule(ColorScaleOptions options = null)

Parameters

options ColorScaleOptions

Returns

ConditionalFormattingRule

ContainsText(string, ConditionalFormattingStyle)

Creates a rule for highlighting cells containing specific text.

public static ConditionalFormattingRule ContainsText(string text, ConditionalFormattingStyle style)

Parameters

text string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

DataBarRule(DataBarOptions)

Creates a rule for data bar visualization.

public static ConditionalFormattingRule DataBarRule(DataBarOptions options = null)

Parameters

options DataBarOptions

Returns

ConditionalFormattingRule

DuplicateValues(ConditionalFormattingStyle)

Creates a rule for highlighting duplicate values.

public static ConditionalFormattingRule DuplicateValues(ConditionalFormattingStyle style)

Parameters

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

EqualTo(string, ConditionalFormattingStyle)

Creates a rule for highlighting cells equal to a value.

public static ConditionalFormattingRule EqualTo(string value, ConditionalFormattingStyle style)

Parameters

value string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

Formula(string, ConditionalFormattingStyle)

Creates a rule based on a custom formula.

public static ConditionalFormattingRule Formula(string formula, ConditionalFormattingStyle style)

Parameters

formula string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

GreaterThan(string, ConditionalFormattingStyle)

Creates a rule for highlighting cells greater than a value.

public static ConditionalFormattingRule GreaterThan(string value, ConditionalFormattingStyle style)

Parameters

value string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

LessThan(string, ConditionalFormattingStyle)

Creates a rule for highlighting cells less than a value.

public static ConditionalFormattingRule LessThan(string value, ConditionalFormattingStyle style)

Parameters

value string

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule

Top10(int, bool, bool, ConditionalFormattingStyle)

Creates a rule for highlighting top N values.

public static ConditionalFormattingRule Top10(int count, bool isPercent, bool isBottom, ConditionalFormattingStyle style)

Parameters

count int

isPercent bool

isBottom bool

style ConditionalFormattingStyle

Returns

ConditionalFormattingRule