public class ConditionalFormatImpl : CommonObject, IDisposable, IInternalConditionalFormat, IConditionalFormat, IParentApplication, IOptimizedUpdate, ICloneParent

Remarks

Contains a condition and the formatting attributes applied to the cells, if the condition is met.

Constructors

ConditionalFormatImpl(IApplication, Object)

Initializes a new instance of ConditionalFormat class.

Declaration

public ConditionalFormatImpl(IApplication application, object parent)

Parameters

Type	Name	Description
IApplication	application	Application object for the ConditionalFormat.
System.Object	parent	Parent object for the ConditionalFormat.

ConditionalFormatImpl(IApplication, Object, BiffRecordRaw[], ref Int32)

Initializes a new instance of ConditionalFormat class from array of BiffRecords.

Declaration

public ConditionalFormatImpl(IApplication application, object parent, BiffRecordRaw[] data, ref int iPos)

Parameters

Type	Name	Description
IApplication	application	Application object for the ConditionalFormat.
System.Object	parent	Parent object for the ConditionalFormat.
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw[]	data	Array of BiffRecords.
System.Int32	iPos	Position of the corresponding CFRecord in the array.

ConditionalFormatImpl(IApplication, Object, CF12Record)

Initializes a new instance of ConditionalFormat class from ConditionalFormat12 Record.

Declaration

public ConditionalFormatImpl(IApplication application, object parent, CF12Record cf12)

Parameters

Type	Name	Description
IApplication	application	Application object for the ConditionalFormat.
System.Object	parent	Parent object for the ConditionalFormat.
CF12Record	cf12	CF12Record to parse.

ConditionalFormatImpl(IApplication, Object, CFExRecord)

Initializes a new instance of ConditionalFormat class from ConditionalFormat Extension Record.

Declaration

public ConditionalFormatImpl(IApplication application, object parent, CFExRecord cfEx)

Parameters

Type	Name	Description
IApplication	application	Application object for the ConditionalFormat.
System.Object	parent	Parent object for the ConditionalFormat.
CFExRecord	cfEx	CFExRecord to parse.

ConditionalFormatImpl(IApplication, Object, CFRecord)

Initializes a new instance of ConditionalFormat class from ConditionalFormat Record.

Declaration

public ConditionalFormatImpl(IApplication application, object parent, CFRecord cf)

Parameters

Type	Name	Description
IApplication	application	Application object for the ConditionalFormat.
System.Object	parent	Parent object for the ConditionalFormat.
CFRecord	cf	CFRecord to parse.

Properties

AboveBelowAverage

Gets AboveBelowAverage conditional formatting rule. Read-only.

Declaration

public IAboveBelowAverage AboveBelowAverage { get; }

Property Value

Type
IAboveBelowAverage

Remarks

Valid only if FormatType is set to AboveAverage.

BackColor

Gets or sets the pattern background color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors BackColor { get; set; }

Property Value

Type
ExcelKnownColors

BackColorObject

Gets the conditional format background color object. Read-only.

Declaration

public ColorObject BackColorObject { get; }

Property Value

Type
ColorObject

BackColorRGB

Gets or sets the pattern background color (Color).

Declaration

public Color BackColorRGB { get; set; }

Property Value

Type
Color

BottomBorderColor

Gets or sets the bottom border color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors BottomBorderColor { get; set; }

Property Value

Type
ExcelKnownColors

BottomBorderColorObject

Gets conditional format bottom border color object. Read-only.

Declaration

public ColorObject BottomBorderColorObject { get; }

Property Value

Type
ColorObject

BottomBorderColorRGB

Gets or sets the bottom border color (Color).

Declaration

public Color BottomBorderColorRGB { get; set; }

Property Value

Type
Color

BottomBorderStyle

Gets or sets the bottom border line style.

Declaration

public ExcelLineStyle BottomBorderStyle { get; set; }

Property Value

Type
ExcelLineStyle

CF12Record

Gets internal ConditionalFormat12 record. Read-only.

Declaration

public CF12Record CF12Record { get; }

Property Value

Type
CF12Record

CFExRecord

Gets internal ConditionalFormatExtension record. Read-only.

Declaration

public CFExRecord CFExRecord { get; }

Property Value

Type
CFExRecord

Color

Gets or sets the pattern foreground color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors Color { get; set; }

Property Value

Type
ExcelKnownColors

ColorObject

Gets the conditional format foreground color object. Read-only.

Declaration

public ColorObject ColorObject { get; }

Property Value

Type
ColorObject

ColorRGB

Gets or sets the pattern foreground color. (Color)

Declaration

public Color ColorRGB { get; set; }

Property Value

Type
Color

ColorScale

Gets color scale conditional formatting rule. Read-only.

Declaration

public IColorScale ColorScale { get; }

Property Value

Type
IColorScale

Remarks

Valid only if FormatType is set to ColorScale.

DataBar

Gets data bar conditional formatting rule. Read-only.

Declaration

public IDataBar DataBar { get; }

Property Value

Type
IDataBar

Remarks

Valid only if FormatType is set to DataBar.

FillPattern

Gets or sets the fill pattern style.

Declaration

public ExcelPattern FillPattern { get; set; }

Property Value

Type
ExcelPattern

FirstFormula

Gets or sets the value or expression associated with the conditional format.

Declaration

public string FirstFormula { get; set; }

Property Value

Type
System.String

FirstFormulaR1C1

Gets or sets the value or expression associated with the conditional format in R1C1 notation.

Declaration

public string FirstFormulaR1C1 { get; set; }

Property Value

Type
System.String

FontColor

Gets or sets the font color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors FontColor { get; set; }

Property Value

Type
ExcelKnownColors

FontColorObject

Gets Conditional format font color object. Read-only.

Declaration

public ColorObject FontColorObject { get; }

Property Value

Type
ColorObject

FontColorRGB

Gets or sets the font color (Color).

Declaration

public Color FontColorRGB { get; set; }

Property Value

Type
Color

FormatType

Gets or sets the type of the conditional format.

Declaration

public ExcelCFType FormatType { get; set; }

Property Value

Type
ExcelCFType

GradientStyle

Gets or Sets the Gradient style for conditional format.

Declaration

public ExcelGradientStyle GradientStyle { get; set; }

Property Value

Type
ExcelGradientStyle

GradientVariant

Gets or Sets the Gradient variant for conditional format.

Declaration

public ExcelGradientVariants GradientVariant { get; set; }

Property Value

Type
ExcelGradientVariants

HasNumberFormatPresent

True if Number format is present. False otherwise.

Declaration

public bool HasNumberFormatPresent { get; set; }

Property Value

Type
System.Boolean

IconSet

Gets icon set conditional formatting rule. Read-only.

Declaration

public IIconSet IconSet { get; }

Property Value

Type
IIconSet

Remarks

Valid only if FormatType is set to IconSet.

IsBackgroundColorPresent

True if background color is present. otherwise, False.

Declaration

public bool IsBackgroundColorPresent { get; set; }

Property Value

Type
System.Boolean

IsBold

Gets or sets a boolean value indicating whether the font is bold.

Declaration

public bool IsBold { get; set; }

Property Value

Type
System.Boolean

IsBorderFormatPresent

True if the conditional format contains border formatting. otherwise, False.

Declaration

public bool IsBorderFormatPresent { get; set; }

Property Value

Type
System.Boolean

IsBottomBorderModified

True if bottom border line style is modified. otherwise, False.

Declaration

public bool IsBottomBorderModified { get; set; }

Property Value

Type
System.Boolean

IsFontColorPresent

True if font color is present. otherwise, False.

Declaration

public bool IsFontColorPresent { get; set; }

Property Value

Type
System.Boolean

IsFontFormatPresent

True if the conditional format contains font formatting. otherwise, False.

Declaration

public bool IsFontFormatPresent { get; set; }

Property Value

Type
System.Boolean

IsItalic

Gets or sets a boolean value indicating whether the font is italic.

Declaration

public bool IsItalic { get; set; }

Property Value

Type
System.Boolean

IsLeftBorderModified

True if left border line style is modified. otherwise, False.

Declaration

public bool IsLeftBorderModified { get; set; }

Property Value

Type
System.Boolean

IsPatternColorPresent

True if pattern color is present. otherwise, False.

Declaration

public bool IsPatternColorPresent { get; set; }

Property Value

Type
System.Boolean

IsPatternFormatPresent

True if the conditional format contains pattern formatting. otherwise, False.

Declaration

public bool IsPatternFormatPresent { get; set; }

Property Value

Type
System.Boolean

IsPatternStyleModified

Indicates whether pattern style was modified.

Declaration

public bool IsPatternStyleModified { get; set; }

Property Value

Type
System.Boolean

IsRightBorderModified

True if right border line style is modified. otherwise, False.

Declaration

public bool IsRightBorderModified { get; set; }

Property Value

Type
System.Boolean

IsStrikeThrough

Gets or sets a Boolean value indicating whether font is struck through.

Declaration

public bool IsStrikeThrough { get; set; }

Property Value

Type
System.Boolean

IsSubScript

Gets or sets a Boolean value indicating whether the font is subscript.

Declaration

public bool IsSubScript { get; set; }

Property Value

Type
System.Boolean

IsSuperScript

Gets or sets a Boolean value indicating whether the font is superscript.

Declaration

public bool IsSuperScript { get; set; }

Property Value

Type
System.Boolean

IsTopBorderModified

True if top border line style is modified. otherwise, False.

Declaration

public bool IsTopBorderModified { get; set; }

Property Value

Type
System.Boolean

LeftBorderColor

Gets or sets the left border color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors LeftBorderColor { get; set; }

Property Value

Type
ExcelKnownColors

LeftBorderColorObject

Gets conditional format left border color object. Read-only.

Declaration

public ColorObject LeftBorderColorObject { get; }

Property Value

Type
ColorObject

LeftBorderColorRGB

Gets or sets the left border color (Color).

Declaration

public Color LeftBorderColorRGB { get; set; }

Property Value

Type
Color

LeftBorderStyle

Gets or sets the left border line style.

Declaration

public ExcelLineStyle LeftBorderStyle { get; set; }

Property Value

Type
ExcelLineStyle

NumberFormat

Gets or sets number format of the conditional format rule.

Declaration

public string NumberFormat { get; set; }

Property Value

Type
System.String

NumberFormatIndex

Gets or sets number format index of the conditional format rule.

Declaration

public ushort NumberFormatIndex { get; set; }

Property Value

Type
System.UInt16

Operator

Gets or sets the comparison operator for the conditional format.

Declaration

public ExcelComparisonOperator Operator { get; set; }

Property Value

Type
ExcelComparisonOperator

Record

Gets internal ConditionatFormat record. Read-only.

Declaration

public CFRecord Record { get; }

Property Value

Type
CFRecord

RightBorderColor

Gets or sets the right border color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors RightBorderColor { get; set; }

Property Value

Type
ExcelKnownColors

RightBorderColorObject

Gets conditional format right border color object. Read-only.

Declaration

public ColorObject RightBorderColorObject { get; }

Property Value

Type
ColorObject

RightBorderColorRGB

Gets or sets the right border color (Color).

Declaration

public Color RightBorderColorRGB { get; set; }

Property Value

Type
Color

RightBorderStyle

Gets or sets the right border line style.

Declaration

public ExcelLineStyle RightBorderStyle { get; set; }

Property Value

Type
ExcelLineStyle

SecondFormula

Gets the value or expression associated with the second part of a conditional format.

Declaration

public string SecondFormula { get; set; }

Property Value

Type
System.String

SecondFormulaR1C1

Gets the value or expression associated with the second part of a conditional format in R1C1 notation.

Declaration

public string SecondFormulaR1C1 { get; set; }

Property Value

Type
System.String

StopIfTrue

Gets or sets a boolean value that determines if additional formatting rules on the cell should be evaluated if the current rule evaluates to True.

Declaration

public bool StopIfTrue { get; set; }

Property Value

Type
System.Boolean

Template

Represents the conditionl format template.

Declaration

public ConditionalFormatTemplate Template { get; set; }

Property Value

Type
ConditionalFormatTemplate

Text

Gets or sets the text value used in SpecificText conditional formatting rule. The default value is null.

Declaration

public string Text { get; set; }

Property Value

Type
System.String

TimePeriodType

Gets or sets one of the constants of CFTimePeriods enumeration which represents the type of the time period.

Declaration

public CFTimePeriods TimePeriodType { get; set; }

Property Value

Type
CFTimePeriods

TopBorderColor

Gets or sets the top border color from predefined colors (ExcelKnownColors).

Declaration

public ExcelKnownColors TopBorderColor { get; set; }

Property Value

Type
ExcelKnownColors

TopBorderColorObject

Gets Conditional format top border color object. Read-only.

Declaration

public ColorObject TopBorderColorObject { get; }

Property Value

Type
ColorObject

TopBorderColorRGB

Gets or sets the top border color (Color).

Declaration

public Color TopBorderColorRGB { get; set; }

Property Value

Type
Color

TopBorderStyle

Gets or sets the top border line style.

Declaration

public ExcelLineStyle TopBorderStyle { get; set; }

Property Value

Type
ExcelLineStyle

TopBottom

Gets TopBottom conditional formatting rule. Read-only.

Declaration

public ITopBottom TopBottom { get; }

Property Value

Type
ITopBottom

Remarks

Valid only if FormatType is set to Top10.

Underline

Gets or sets the underline type for the conditional format.

Declaration

public ExcelUnderline Underline { get; set; }

Property Value

Type
ExcelUnderline

Workbook

Gets parent workbook. Read-only.

Declaration

public WorkbookImpl Workbook { get; }

Property Value

Type
WorkbookImpl

Methods

BeginUpdate()

Initiates updates to the object.

Declaration

public void BeginUpdate()

Remarks

This method should be called before several updates to the object will take place.

Clone(Object)

Creates a new object that is a copy of the current instance.

Declaration

public object Clone(object parent)

Parameters

Type	Name	Description
System.Object	parent	Parent object for a copy of this instance.

Returns

Type	Description
System.Object	A new object that is a copy of this instance.

EndUpdate()

Ends updating the object. This method should be called after several updates to the object took place.

Declaration

public void EndUpdate()

Equals(Object)

Compares the current Object with the specified object without taking cell list into account.

Declaration

public override bool Equals(object obj)

Parameters

Type	Name	Description
System.Object	obj	The Object to compare with the current Object.

Returns

Type	Description
System.Boolean	Booleab value indicating if the objects compared are equal.

GetFirstSecondFormula(FormulaUtil, Boolean)

Gets first or second formula string value from the conditional format.

Declaration

public string GetFirstSecondFormula(FormulaUtil formulaUtil, bool bIsFirstFormula)

Parameters

Type	Name	Description
FormulaUtil	formulaUtil	Formula util.
System.Boolean	bIsFirstFormula	Boolean value indicating first formula.

Returns

Type	Description
System.String	First/second formula string value.

GetHashCode()

Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

Declaration

public override int GetHashCode()

Returns

Type	Description
System.Int32	A hash code for the current Object.

MarkUsedReferences(Boolean[])

Sets items with used reference indexes to true.

Declaration

public void MarkUsedReferences(bool[] usedItems)

Parameters

Type	Name	Description
System.Boolean[]	usedItems	Array to mark used references in.

Parse(BiffRecordRaw[], ref Int32)

Parses Conditional format data from an array of BiffRecords.

Declaration

public void Parse(BiffRecordRaw[] data, ref int iPos)

Parameters

Type	Name	Description
Syncfusion.XlsIO.Parser.Biff_Records.BiffRecordRaw[]	data	Array of BiffRecords.
System.Int32	iPos	Position of the corresponding CFRecord in the array.

Serialize(OffsetArrayList)

Serializes ConditionalFormat records.

Declaration

public void Serialize(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will get all data of conditional format records.

SerializeCF12(OffsetArrayList)

Serializes ConditionalFormat12 records.

Declaration

public void SerializeCF12(OffsetArrayList records)

Parameters

Type	Name	Description
OffsetArrayList	records	OffsetArrayList that will get all data of ConditionalFormat12 records.

SetFirstSecondFormula(FormulaUtil, String, Boolean)

Sets first or second formula value to the conditional format.

Declaration

public void SetFirstSecondFormula(FormulaUtil formulaUtil, string strFormula, bool bIsFirstFormula)

Parameters

Type	Name	Description
FormulaUtil	formulaUtil	Formula util object.
System.String	strFormula	Formula string.
System.Boolean	bIsFirstFormula	Boolean value indicating first formula.

SetSpecificTextFormula(ExcelComparisonOperator, RangeImpl)

Sets formula for the specified range in SpecificText conditional format.

Declaration

public string SetSpecificTextFormula(ExcelComparisonOperator compOperator, RangeImpl range)

Parameters

Type	Name	Description
ExcelComparisonOperator	compOperator	Value for Excel comparision operator.
RangeImpl	range	Range value.

Returns

Type
System.String

SetSpecificTextString(ExcelComparisonOperator, String)

Sets the specifed text value for the SpecficText conditional format.

Declaration

public void SetSpecificTextString(ExcelComparisonOperator compOperator, string value)

Parameters

Type	Name	Description
ExcelComparisonOperator	compOperator	Excel comparision operator value.
System.String	value	String value to be set.

UpdateFormula(Int32, Int32, Rectangle, Int32, Rectangle, Int32, Int32)

Updates conditional format formulas.

Declaration

public void UpdateFormula(int iCurIndex, int iSourceIndex, Rectangle sourceRect, int iDestIndex, Rectangle destRect, int row, int column)

Parameters

Type	Name	Description
System.Int32	iCurIndex	Current worksheet index.
System.Int32	iSourceIndex	Source worksheet index.
Rectangle	sourceRect	Source rectangle.
System.Int32	iDestIndex	Destination worksheet index.
Rectangle	destRect	Destination rectangle.
System.Int32	row
System.Int32	column

UpdateReferenceIndexes(Int32[])

Updates reference indexes.

Declaration

public void UpdateReferenceIndexes(int[] arrUpdatedIndexes)

Parameters

Type	Name	Description
System.Int32[]	arrUpdatedIndexes	Array with updated indexes.

Implements

System.IDisposable

IConditionalFormat

IParentApplication

IOptimizedUpdate

ICloneParent