Class ExcelConditionalFormattingAsType

Provides a simple way to type cast a conditional formatting object to its top level class.

Inheritance

System.Object

ExcelConditionalFormattingAsType

Inherited Members

System.Object.Equals(System.Object)

System.Object.Equals(System.Object, System.Object)

System.Object.GetHashCode()

System.Object.GetType()

System.Object.MemberwiseClone()

System.Object.ReferenceEquals(System.Object, System.Object)

System.Object.ToString()

Namespace: OfficeOpenXml.ConditionalFormatting

Assembly: EPPlus.dll

Syntax

public class ExcelConditionalFormattingAsType

Properties

Average

Returns the conditional formatting object as an Average rule If this object is not of type AboveAverage, AboveOrEqualAverage, BelowAverage or BelowOrEqualAverage, null will be returned

Declaration

public IExcelConditionalFormattingAverageGroup Average { get; }

Property Value

Type	Description
IExcelConditionalFormattingAverageGroup	The conditional formatting rule as an Average rule

BeginsWith

Returns the conditional formatting object as a BeginsWith rule If this object is not of type BeginsWith, null will be returned

Declaration

public IExcelConditionalFormattingBeginsWith BeginsWith { get; }

Property Value

Type	Description
IExcelConditionalFormattingBeginsWith	The conditional formatting object as a BeginsWith rule

Between

Returns the conditional formatting object as a Between rule If this object is not of type Between, null will be returned

Declaration

public IExcelConditionalFormattingBetween Between { get; }

Property Value

Type	Description
IExcelConditionalFormattingBetween	The conditional formatting object as a Between rule

ContainsBlanks

Returns the conditional formatting object as a ContainsBlanks rule If this object is not of type ContainsBlanks, null will be returned

Declaration

public IExcelConditionalFormattingContainsBlanks ContainsBlanks { get; }

Property Value

Type	Description
IExcelConditionalFormattingContainsBlanks	The conditional formatting object as a ContainsBlanks rule

ContainsErrors

Returns the conditional formatting object as a ContainsErrors rule If this object is not of type ContainsErrors, null will be returned

Declaration

public IExcelConditionalFormattingContainsErrors ContainsErrors { get; }

Property Value

Type	Description
IExcelConditionalFormattingContainsErrors	The conditional formatting object as a ContainsErrors rule

ContainsText

Returns the conditional formatting object as a ContainsText rule If this object is not of type ContainsText, null will be returned

Declaration

public IExcelConditionalFormattingContainsText ContainsText { get; }

Property Value

Type	Description
IExcelConditionalFormattingContainsText	The conditional formatting object as a ContainsText rule

DataBar

Returns the conditional formatting object as a DataBar rule If this object is not of type DataBar, null will be returned

Declaration

public IExcelConditionalFormattingDataBarGroup DataBar { get; }

Property Value

Type	Description
IExcelConditionalFormattingDataBarGroup	The conditional formatting object as a DataBar rule

DateTimePeriod

Returns the conditional formatting object as a DateTimePeriod rule If this object is not of type Last7Days, LastMonth, LastWeek, NextMonth, NextWeek, ThisMonth, ThisWeek, Today, Tomorrow or Yesterday, null will be returned

Declaration

public IExcelConditionalFormattingTimePeriodGroup DateTimePeriod { get; }

Property Value

Type	Description
IExcelConditionalFormattingTimePeriodGroup	The conditional formatting object as a DateTimePeriod rule

DuplicateValues

Returns the conditional formatting object as a DuplicateValues rule If this object is not of type DuplicateValues, null will be returned

Declaration

public IExcelConditionalFormattingDuplicateValues DuplicateValues { get; }

Property Value

Type	Description
IExcelConditionalFormattingDuplicateValues	The conditional formatting object as a DuplicateValues rule

EndsWith

Returns the conditional formatting object as an EndsWith rule If this object is not of type EndsWith, null will be returned

Declaration

public IExcelConditionalFormattingEndsWith EndsWith { get; }

Property Value

Type	Description
IExcelConditionalFormattingEndsWith	The conditional formatting object as an EndsWith rule

Equal

Returns the conditional formatting object as an Equal rule If this object is not of type Equal, null will be returned

Declaration

public IExcelConditionalFormattingEqual Equal { get; }

Property Value

Type	Description
IExcelConditionalFormattingEqual	The conditional formatting object as an Equal rule

Expression

Returns the conditional formatting object as an Expression rule If this object is not of type Expression, null will be returned

Declaration

public IExcelConditionalFormattingExpression Expression { get; }

Property Value

Type	Description
IExcelConditionalFormattingExpression	The conditional formatting object as an Expression rule

FiveIconSet

Returns the conditional formatting object as a FiveIconSet rule If this object is not of type FiveIconSet, null will be returned

Declaration

public IExcelConditionalFormattingFiveIconSet FiveIconSet { get; }

Property Value

Type	Description
IExcelConditionalFormattingFiveIconSet	The conditional formatting object as a FiveIconSet rule

FourIconSet

Returns the conditional formatting object as a FourIconSet rule If this object is not of type FourIconSet, null will be returned

Declaration

public IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType> FourIconSet { get; }

Property Value

Type	Description
IExcelConditionalFormattingFourIconSet<eExcelconditionalFormatting4IconsSetType>	The conditional formatting object as a FourIconSet rule

GreaterThan

Returns the conditional formatting object as a GreaterThan rule If this object is not of type GreaterThan, null will be returned

Declaration

public IExcelConditionalFormattingGreaterThan GreaterThan { get; }

Property Value

Type	Description
IExcelConditionalFormattingGreaterThan	The conditional formatting object as a GreaterThan rule

GreaterThanOrEqual

Returns the conditional formatting object as a GreaterThanOrEqual rule If this object is not of type GreaterThanOrEqual, null will be returned

Declaration

public IExcelConditionalFormattingGreaterThanOrEqual GreaterThanOrEqual { get; }

Property Value

Type	Description
IExcelConditionalFormattingGreaterThanOrEqual	The conditional formatting object as a GreaterThanOrEqual rule

LessThan

Returns the conditional formatting object as a LessThan rule If this object is not of type LessThan, null will be returned

Declaration

public IExcelConditionalFormattingLessThan LessThan { get; }

Property Value

Type	Description
IExcelConditionalFormattingLessThan	The conditional formatting object as a LessThan rule

LessThanOrEqual

Returns the conditional formatting object as a LessThanOrEqual rule If this object is not of type LessThanOrEqual, null will be returned

Declaration

public IExcelConditionalFormattingLessThanOrEqual LessThanOrEqual { get; }

Property Value

Type	Description
IExcelConditionalFormattingLessThanOrEqual	The conditional formatting object as a LessThanOrEqual rule

NotBetween

Returns the conditional formatting object as a NotBetween rule If this object is not of type NotBetween, null will be returned

Declaration

public IExcelConditionalFormattingNotBetween NotBetween { get; }

Property Value

Type	Description
IExcelConditionalFormattingNotBetween	The conditional formatting object as a NotBetween rule

NotContainsBlanks

Returns the conditional formatting object as a NotContainsBlanks rule If this object is not of type NotContainsBlanks, null will be returned

Declaration

public IExcelConditionalFormattingNotContainsBlanks NotContainsBlanks { get; }

Property Value

Type	Description
IExcelConditionalFormattingNotContainsBlanks	The conditional formatting object as a NotContainsBlanks rule

NotContainsErrors

Returns the conditional formatting object as a NotContainsErrors rule If this object is not of type NotContainsErrors, null will be returned

Declaration

public IExcelConditionalFormattingNotContainsErrors NotContainsErrors { get; }

Property Value

Type	Description
IExcelConditionalFormattingNotContainsErrors	The conditional formatting object as a NotContainsErrors rule

NotContainsText

Returns the conditional formatting object as a NotContainsText rule If this object is not of type NotContainsText, null will be returned

Declaration

public IExcelConditionalFormattingNotContainsText NotContainsText { get; }

Property Value

Type	Description
IExcelConditionalFormattingNotContainsText	The conditional formatting object as a NotContainsText rule

NotEqual

Returns the conditional formatting object as a NotEqual rule If this object is not of type NotEqual, null will be returned

Declaration

public IExcelConditionalFormattingNotEqual NotEqual { get; }

Property Value

Type	Description
IExcelConditionalFormattingNotEqual	The conditional formatting object as a NotEqual rule

StdDev

Returns the conditional formatting object as a StdDev rule If this object is not of type AboveStdDev or BelowStdDev, null will be returned

Declaration

public IExcelConditionalFormattingStdDevGroup StdDev { get; }

Property Value

Type	Description
IExcelConditionalFormattingStdDevGroup	The conditional formatting object as a StdDev rule

ThreeColorScale

Returns the conditional formatting object as a ThreeColorScale rule If this object is not of type ThreeColorScale, null will be returned

Declaration

public IExcelConditionalFormattingThreeColorScale ThreeColorScale { get; }

Property Value

Type	Description
IExcelConditionalFormattingThreeColorScale	The conditional formatting object as a ThreeColorScale rule

ThreeIconSet

Returns the conditional formatting object as a ThreeIconSet rule If this object is not of type ThreeIconSet, null will be returned

Declaration

public IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType> ThreeIconSet { get; }

Property Value

Type	Description
IExcelConditionalFormattingThreeIconSet<eExcelconditionalFormatting3IconsSetType>	The conditional formatting object as a ThreeIconSet rule

TopBottom

Returns the conditional formatting object as a TopBottom rule If this object is not of type Bottom, BottomPercent, Top or TopPercent, null will be returned

Declaration

public IExcelConditionalFormattingTopBottomGroup TopBottom { get; }

Property Value

Type	Description
IExcelConditionalFormattingTopBottomGroup	The conditional formatting object as a TopBottom rule

TwoColorScale

Returns the conditional formatting object as a TwoColorScale rule If this object is not of type TwoColorScale, null will be returned

Declaration

public IExcelConditionalFormattingTwoColorScale TwoColorScale { get; }

Property Value

Type	Description
IExcelConditionalFormattingTwoColorScale	The conditional formatting object as a TwoColorScale rule

UniqueValues

Returns the conditional formatting object as a UniqueValues rule If this object is not of type UniqueValues, null will be returned

Declaration

public IExcelConditionalFormattingUniqueValues UniqueValues { get; }

Property Value

Type	Description
IExcelConditionalFormattingUniqueValues	The conditional formatting object as a UniqueValues rule

Methods

Type<T>()

Converts the conditional formatting object to it's top level or another nested class.

Declaration

public T Type<T>()
    where T : IExcelConditionalFormattingRule

Returns

Type	Description
T	The conditional formatting rule as type T

Type Parameters

Name	Description
T	The type of conditional formatting object. T must be inherited from IExcelConditionalFormattingRule