Class ConditionalFormatGroup

Summary description for ConditionalFormatGroup.

Inheritance

System.Object

CommonObject

ConditionalFormatGroup

Implements

System.IDisposable

IConditionalFormat

IParentApplication

IOptimizedUpdate

Inherited Members

CommonObject.AddReference()

CommonObject.AppImplementation

CommonObject.Application

CommonObject.CheckDisposed()

CommonObject.Dispose()

CommonObject.Finalize()

CommonObject.FindParent(Object, Type)

CommonObject.FindParent(Object, Type, Boolean)

CommonObject.FindParent(Type)

CommonObject.FindParent(Type, Boolean)

CommonObject.FindParent(Type[])

CommonObject.FindParents(Type[])

CommonObject.m_bIsDisposed

CommonObject.OnDispose()

CommonObject.Parent

CommonObject.ReferenceCount

CommonObject.ReleaseReference()

CommonObject.SetParent(Object)

Namespace: Syncfusion.XlsIO.Implementation.Collections.Grouping

Assembly: Syncfusion.XlsIO.Portable.dll

Syntax

public class ConditionalFormatGroup : CommonObject, IDisposable, IConditionalFormat, IParentApplication, IOptimizedUpdate

Constructors

ConditionalFormatGroup(IApplication, Object, Int32)

Creates new instance of the group.

Declaration

public ConditionalFormatGroup(IApplication application, object parent, int index)

Parameters

Type	Name	Description
IApplication	application	Application object for the new group.
System.Object	parent	Parent object for the new group.
System.Int32	index	Format index.

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

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

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

Color

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

Declaration

public ExcelKnownColors Color { get; set; }

Property Value

Type
ExcelKnownColors

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

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

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

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

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

Operator

Gets or sets the comparison operator for the conditional format.

Declaration

public ExcelComparisonOperator Operator { get; set; }

Property Value

Type
ExcelComparisonOperator

RightBorderColor

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

Declaration

public ExcelKnownColors RightBorderColor { get; set; }

Property Value

Type
ExcelKnownColors

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

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

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

Methods

BeginUpdate()

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

Declaration

public void BeginUpdate()

EndUpdate()

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

Declaration

public void EndUpdate()

Implements

System.IDisposable

IConditionalFormat

IParentApplication

IOptimizedUpdate