Click or drag to resize

XlsConditionalFormats Class

Collection of conditional formats for the single-cell range.
Inheritance Hierarchy
System Object
Spire.Xls.Core.Spreadsheet.Collections CollectionBase IConditionalFormat
Spire.Xls.Core.Spreadsheet.Collections CollectionExtended IConditionalFormat
Spire.Xls.Core.Spreadsheet.Collections XlsConditionalFormats

Namespace: Spire.Xls.Core.Spreadsheet.Collections
Assembly: Spire.XLS (in Spire.XLS.dll) Version: 15.4.0.0 (15.4.0.5046)
Syntax
Copy 
public class XlsConditionalFormats : CollectionExtended<IConditionalFormat>, 
	IConditionalFormats, IEnumerable, IExcelApplication

The XlsConditionalFormats type exposes the following members.

Properties
Name Description
Public property Address
Represents address of cf ranges.
Public property AddressR1C1
Represents address of cf ranges in R1C1 notation.
Public property Capacity
Gets or sets the total number of elements the internal data structure can hold without resizing.
Public property CellRectangles
Gets list of rectangles describing cells with conditional formatting.
Public property Count
Gets the count of items in the collection.
Protected property InnerList
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property IsEmpty
Indicates whether collection is empty. Read-only.
Public property IsReadOnly
Gets a value indicating whether the collection is read-only.
(Inherited from CollectionBase T .)
Public property Item
Gets the IConditionalFormat for the specified field index.
Protected property List
Gets the list of elements in the instance.
(Inherited from CollectionBase T .)
Public property Parent
Read-oonly. The parent object for the specified object.
(Inherited from CollectionExtended T .)
Top
Methods
Name Description
Public method Add
Adds an item to the collection.trigger OnInsert and OnInsertComplete method when set item
(Inherited from CollectionBase T .)
Public method AddAverageCondition
Add new above or below the average condition to the collection.
Public method AddBeginsWithCondition
Add new begin with condition to the collection.
Public method AddCells(IList)
Adds cells from the collection.
Public method AddCells(XlsConditionalFormats)
Adds cells from the collection.
Public method AddCellValueCondition(ComparisonOperatorType, Double, Double)
Add new cell value condition to the collection.
Public method AddCellValueCondition(ComparisonOperatorType, String, String)
Add new cell value condition to the collection.
Public method AddCondition
Adds new condition to the collection.
Public method AddContainsBlanksCondition
Add new contain blanks condition to the collection.
Public method AddContainsErrorsCondition
Add new contain errors condition to the collection.
Public method AddContainsTextCondition
Add new contain condition to the collection.
Public method AddDuplicateValuesCondition
Add new duplicate values condition to the collection.
Public method AddEndsWithCondition
Add new end with condition to the collection.
Public method AddNotContainsBlanksCondition
Add new not contain blanks condition to the collection.
Public method AddNotContainsErrorsCondition
Add new not contain errors condition to the collection.
Public method AddNotContainsTextCondition
Add new not contain condition to the collection.
Public method AddRange
Adds range to the collection.
Public method AddTimePeriodCondition
Add new time period condition to the collection.
Public method AddTopBottomCondition
Add new TopN or BottomN condition to the collection.
Public method AddUniqueValuesCondition
Add new unique values condition to the collection.
Public method BeginUpdate Obsolete.
This method should be called before several updates to the object will take place.
Public method Clear
Clears the contents of the collection.
Public method ClearCells
Removes all cells from the collection.
Public method Clone
Creates a new object that is a copy of the current instance.
(Overrides CollectionExtended T Clone(Object) .)
Public method CompareFormats Obsolete.
Compares two ConditionalFormats.
Public method CompareTo
Compares this collection to another.
Public method Contains(T)
Determines whether the collection contains a specific item.
(Inherited from CollectionBase T .)
Public method Contains( Rectangle )
Indicates whether collection contains all specified ranges.
Public method ContainsCount
Returns contains count for specified range.
Public method CopyTo
Copies the elements of the collection to an array, starting at a particular array index.
(Inherited from CollectionBase T .)
Public method EndUpdate Obsolete.
This method should be called after several updates to the object took place.
Public method EnsureCapacity
Enlarges internal storage if necessary.
(Inherited from CollectionExtended T .)
Public method Equals
A hash code for the current Object without taking cell list into account.
(Overrides Object Equals(Object) .)
Protected method Finalize
Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection.
(Inherited from Object .)
Protected method FindParent(Type)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Protected method FindParent(Type, Boolean)
Method used to find parent within a specific type.
(Inherited from CollectionExtended T .)
Public method GetByIndex
Returns a single Filter object from a collection.
Public method GetEnumerator
Returns an enumerator that iterates through the collection.
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 IndexOf
Returns the zero-based index of the first occurrence of a specified item within the collection.
(Inherited from CollectionBase T .)
Public method Insert
Inserts an element into the list at the specified index.
(Inherited from CollectionBase T .)
Protected method MemberwiseClone
Creates a shallow copy of the current Object .
(Inherited from Object .)
Protected method OnClear
OnClear is invoked before Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnClearComplete
OnClear is invoked after Clear behavior.
(Inherited from CollectionExtended T .)
Protected method OnInsert
Performs additional processes before inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnInsertComplete
Performs additional processes after inserting a new element into the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemove
Performs additional processes before removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnRemoveComplete
Performs additional processes after removing an element from the collection.
(Inherited from CollectionExtended T .)
Protected method OnSet
Performs additional processes before setting a value in the collection.
(Inherited from CollectionExtended T .)
Protected method OnSetComplete
Performs additional processes after setting a value in the collection.
(Inherited from CollectionExtended T .)
Public method Remove(T)
Removes the first occurrence of a specific object from the collection.
(Inherited from CollectionBase T .)
Public method Remove( Rectangle )
Removes range from the collection of conditional formats.
Public method Remove(Int32, Int32, Int32, Int32)
Removes the Condtional Format at the specified range
Public method RemoveAt
Removes the Condtional Format at the Specified Index
Protected method SetParent
Sets parent object for class.
(Inherited from CollectionExtended T .)
Public method ToString
Returns a string that represents the current object.
(Inherited from Object .)
Top
Events
Fields
Name Description
Public field Static member MAXIMUM_CF_NUMBER
Maximum number of conditional formats in the collection.
Top
See Also