Click or drag to resize

XlsConditionalFormat 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.Core.Spreadsheet
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsConditionalFormat : XlsObject, 
	IConditionalFormat, IExcelApplication, ICloneParent

The XlsConditionalFormat 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.
Public property BackColor
Pattern background color.
Public property BackColorObject
Conditional format background color. Read-only.
Public property BackKnownColor
Pattern background excel color.
Public property BottomBorderColor
Color of the bottom line.
Public property BottomBorderColorObject
Conditional format bottom border color. Read-only.
Public property BottomBorderKnownColor
Excel color of the bottom line.
Public property BottomBorderStyle
Bottom border line style.
Public property Color
Pattern foreground color.
Public property ColorScale
Get the conditional formatting's "ColorScale" instance. The default instance is a "green-red" 2ColorScale . Valid only for type = ColorScale.
Public property DataBar
Gets the DataBar object associated with the current instance.
Public property DxfId
Gets or sets the DXF ID, which is a unique identifier for an entity in a DXF (Drawing Interchange Format) file.
Public property FillPattern
XlsFill pattern type.
Public property FirstFormula
First formula.
Public property FirstFormulaR1C1 Obsolete.
First formula in R1C1 notation. Read only.
Public property FontColor
Font color.
Public property FontColorObject
Conditional format font color. Read-only.
Public property FontKnownColor
Font excel color.
Public property FormatType
conditional format type.
Public property IconSet
Returns iconset settings. Valid only if FormatType is set to IconSet. Read-only.
Public property IsBackgroundColorPresent
Indicates whether background color present.
Public property IsBold
Indicates whether font is bold.
Public property IsBorderFormatPresent
Indicates whether contains border formatting.
Public property IsBottomBorderModified
Indicates whether bottom border style and color are modified.
Public property IsFontColorPresent
Indicates whether format color present.
Public property IsFontFormatPresent
Indicates whether contains font formatting.
Public property IsItalic
Indicates whether font is italic.
Public property IsLeftBorderModified
Indicates whether left border style and color are modified.
Public property IsNumberFormatPresent
Determines whether the specified input contains a number format.
Public property IsPatternColorPresent
Indicates whether presents pattern color.
Public property IsPatternFormatPresent
Indicates whether contains pattern formatting.
Public property IsPatternStyleModified
Indicates whether pattern style was modified.
Public property IsRightBorderModified
Indicates right border style and color modified.
Public property IsStrikeThrough
Indicates whether font is striked through.
Public property IsSubScript
Indicates whether font is subscript.
Public property IsSuperScript
Indicates whether font is superscript.
Public property IsTopBorderModified
Indicates whether top border style and color are modified.
Public property KnownColor
Pattern foreground excel color.
Public property LeftBorderColor
Color of the left line.
Public property LeftBorderColorObject
Conditional format left border color. Read-only.
Public property LeftBorderKnownColor
Excel color of the left line.
Public property LeftBorderStyle
Left border line style.
Public property NumberFormat
Gets or sets the number format of the cell.
Public property OColor
Conditional format color. Read-only.
Public property Operator
Type of the comparison operator.
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.
Protected property ReferenceCount
Get quantity of instance references.
(Inherited from XlsObject .)
Public property RightBorderColor
Color of the right line.
Public property RightBorderColorObject
Conditional format right border color. Read-only.
Public property RightBorderKnownColor
Color of the right line.
Public property RightBorderStyle
Right border line style.
Public property SecondFormula
Second formula.
Public property SecondFormulaR1C1 Obsolete.
Second formula in R1C1 notation. Read only.
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;
Public property TopBorderColor
Color of the top line.
Public property TopBorderColorObject
Conditional format top border color. Read-only.
Public property TopBorderKnownColor
Excel color of the top line.
Public property TopBorderStyle
Top border line style.
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.
Public property Underline
Underline type.
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.
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.
(Overrides Object Equals(Object) .)
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.
(Overrides Object GetHashCode .)
Public method GetType
Gets the Type of the current instance.
(Inherited from Object .)
Public method MakeFormula Obsolete.
Not implemented
Public method MakeFormula(Double)
Generates a formula based on the conditional format type and a given parameter.
Public method MakeFormula(String) Obsolete.
Not implemented
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.
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Public method UpdateFormula Obsolete.
Updates conditional format formulas.
Top
Fields
Name Description
Protected field m_bIsDisposed
Flag which indicates if the object was disposed or not.
(Inherited from XlsObject .)
Top
See Also