Click or drag to resize

ConditionalFormat Class

Contains a condition and the formatting for cells.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet XlsObject
Spire.Xls.Core.Spreadsheet XlsConditionalFormat
Spire.Xls ConditionalFormat

Namespace: Spire.Xls
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class ConditionalFormat : XlsConditionalFormat

The ConditionalFormat type exposes the following members.

Properties
Name Description
Public property Average
Get the conditional formatting's "Average" instance. The default instance's rule highlights cells that are above the average for all values in the range. Valid only for type = Average.
(Inherited from XlsConditionalFormat .)
Public property BackColor
Pattern background color.
(Inherited from XlsConditionalFormat .)
Public property BackColorObject
Conditional format background color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property BackKnownColor
Pattern background excel color.
(Inherited from XlsConditionalFormat .)
Public property BottomBorderColor
Color of the bottom line.
(Inherited from XlsConditionalFormat .)
Public property BottomBorderColorObject
Conditional format bottom border color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property BottomBorderKnownColor
Excel color of the bottom line.
(Inherited from XlsConditionalFormat .)
Public property BottomBorderStyle
Bottom border line style.
(Inherited from XlsConditionalFormat .)
Public property Color
Pattern foreground color.
(Inherited from XlsConditionalFormat .)
Public property ColorScale
Get the conditional formatting's "ColorScale" instance. The default instance is a "green-red" 2ColorScale . Valid only for type = ColorScale.
(Inherited from XlsConditionalFormat .)
Public property DataBar
Gets the DataBar object associated with the current instance.
(Inherited from XlsConditionalFormat .)
Public property DxfId
Gets or sets the DXF ID, which is a unique identifier for an entity in a DXF (Drawing Interchange Format) file.
(Inherited from XlsConditionalFormat .)
Public property FillPattern
XlsFill pattern type.
(Inherited from XlsConditionalFormat .)
Public property FirstFormula
First formula.
(Inherited from XlsConditionalFormat .)
Public property FirstFormulaR1C1 Obsolete.
First formula in R1C1 notation. Read only.
(Inherited from XlsConditionalFormat .)
Public property FontColor
Font color.
(Inherited from XlsConditionalFormat .)
Public property FontColorObject
Conditional format font color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property FontKnownColor
Font excel color.
(Inherited from XlsConditionalFormat .)
Public property FormatType
conditional format type.
(Inherited from XlsConditionalFormat .)
Public property IconSet
Returns iconset settings. Valid only if FormatType is set to IconSet. Read-only.
(Inherited from XlsConditionalFormat .)
Public property IsBackgroundColorPresent
Indicates whether background color present.
(Inherited from XlsConditionalFormat .)
Public property IsBold
Indicates whether font is bold.
(Inherited from XlsConditionalFormat .)
Public property IsBorderFormatPresent
Indicates whether contains border formatting.
(Inherited from XlsConditionalFormat .)
Public property IsBottomBorderModified
Indicates whether bottom border style and color are modified.
(Inherited from XlsConditionalFormat .)
Public property IsFontColorPresent
Indicates whether format color present.
(Inherited from XlsConditionalFormat .)
Public property IsFontFormatPresent
Indicates whether contains font formatting.
(Inherited from XlsConditionalFormat .)
Public property IsItalic
Indicates whether font is italic.
(Inherited from XlsConditionalFormat .)
Public property IsLeftBorderModified
Indicates whether left border style and color are modified.
(Inherited from XlsConditionalFormat .)
Public property IsNumberFormatPresent
Determines whether the specified input contains a number format.
(Inherited from XlsConditionalFormat .)
Public property IsPatternColorPresent
Indicates whether presents pattern color.
(Inherited from XlsConditionalFormat .)
Public property IsPatternFormatPresent
Indicates whether contains pattern formatting.
(Inherited from XlsConditionalFormat .)
Public property IsPatternStyleModified
Indicates whether pattern style was modified.
(Inherited from XlsConditionalFormat .)
Public property IsRightBorderModified
Indicates right border style and color modified.
(Inherited from XlsConditionalFormat .)
Public property IsStrikeThrough
Indicates whether font is striked through.
(Inherited from XlsConditionalFormat .)
Public property IsSubScript
Indicates whether font is subscript.
(Inherited from XlsConditionalFormat .)
Public property IsSuperScript
Indicates whether font is superscript.
(Inherited from XlsConditionalFormat .)
Public property IsTopBorderModified
Indicates whether top border style and color are modified.
(Inherited from XlsConditionalFormat .)
Public property KnownColor
Pattern foreground excel color.
(Inherited from XlsConditionalFormat .)
Public property LeftBorderColor
Color of the left line.
(Inherited from XlsConditionalFormat .)
Public property LeftBorderColorObject
Conditional format left border color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property LeftBorderKnownColor
Excel color of the left line.
(Inherited from XlsConditionalFormat .)
Public property LeftBorderStyle
Left border line style.
(Inherited from XlsConditionalFormat .)
Public property NumberFormat
Gets or sets the number format of the cell.
(Inherited from XlsConditionalFormat .)
Public property OColor
Conditional format color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property Operator
Type of the comparison operator.
(Inherited from XlsConditionalFormat .)
Public property Parent
Reference to Parent object. Read-only.
(Inherited from XlsObject .)
Public property Priority
The priority of this conditional formatting rule. This value is used to determine which format should be evaluated and rendered. Lower numeric values are higher priority than higher numeric values, where '1' is the highest priority.
(Inherited from XlsConditionalFormat .)
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RightBorderColor
Color of the right line.
(Inherited from XlsConditionalFormat .)
Public property RightBorderColorObject
Conditional format right border color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property RightBorderKnownColor
Color of the right line.
(Inherited from XlsConditionalFormat .)
Public property RightBorderStyle
Right border line style.
(Inherited from XlsConditionalFormat .)
Public property SecondFormula
Second formula.
(Inherited from XlsConditionalFormat .)
Public property SecondFormulaR1C1 Obsolete.
Second formula in R1C1 notation. Read only.
(Inherited from XlsConditionalFormat .)
Public property StopIfTrue
True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. Only applies for Excel 2007;
(Inherited from XlsConditionalFormat .)
Public property TopBorderColor
Color of the top line.
(Inherited from XlsConditionalFormat .)
Public property TopBorderColorObject
Conditional format top border color. Read-only.
(Inherited from XlsConditionalFormat .)
Public property TopBorderKnownColor
Excel color of the top line.
(Inherited from XlsConditionalFormat .)
Public property TopBorderStyle
Top border line style.
(Inherited from XlsConditionalFormat .)
Public property TopBottom
Get the conditional formatting's "TopBottom" instance. The default instance's rule highlights cells whose values fall in the top 10 bracket. Valid only for type = TopBottom.
(Inherited from XlsConditionalFormat .)
Public property Underline
Underline type.
(Inherited from XlsConditionalFormat .)
Top
Methods
Name Description
Protected method AddReference
Increase the quantity of reference. User must use this method when new wrapper on object is created or reference on object stored.
(Inherited from XlsObject .)
Protected method CheckDisposed
Checks whether object was disposed and throws exception if it was.
(Inherited from XlsObject .)
Public method Clone
Creates a new object that is a copy of the current instance.
(Inherited from XlsConditionalFormat .)
Public method Dispose
Dispose object and free resources.
(Inherited from XlsObject .)
Public method Equals
A hash code for the current Object without taking cell list into account.
(Inherited from XlsConditionalFormat .)
Protected method Finalize
Destructor. Call dispose method of current object.
(Inherited from XlsObject .)
Protected method FindParent(Type)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParent( Type )
Find parent of object.
(Inherited from XlsObject .)
Protected method FindParent(Type, Boolean)
This method is used to find parent with specific type.
(Inherited from XlsObject .)
Protected method FindParents
Finds parent objects.
(Inherited from XlsObject .)
Public method GetHashCode
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
(Inherited from XlsConditionalFormat .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method MakeFormula Obsolete.
Not implemented
(Inherited from XlsConditionalFormat .)
Public method MakeFormula(Double)
Generates a formula based on the conditional format type and a given parameter.
(Inherited from XlsConditionalFormat .)
Public method MakeFormula(String) Obsolete.
Not implemented
(Inherited from XlsConditionalFormat .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnDispose
Method which can be overriden by users to take any specific actions when object is disposed.
(Inherited from XlsObject .)
Protected method ReleaseReference
Decrease quantity of Reference. User must call this method when freeing resources.
(Inherited from XlsObject .)
Protected method SetParent
Sets parent of the object.
(Inherited from XlsObject .)
Public method SetTimePeriod
Sets the time period for the specified type.
(Inherited from XlsConditionalFormat .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method UpdateFormula Obsolete.
Updates conditional format formulas.
(Inherited from XlsConditionalFormat .)
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also