XlsConditionalFormats module

class XlsConditionalFormats.XlsConditionalFormats

Bases: SpireObject, ICloneParent, IConditionalFormats

AddAverageCondition(averageType: AverageType) → IConditionalFormat

<summary>: Add new above or below the average condition to the collection.

</summary> <param name=”averageType”>type of the average</param> <returns></returns>

AddBeginsWithCondition(text: str) → IConditionalFormat

<summary>: Add new begin with condition to the collection.

</summary> <param name=”text”>begin with text</param> <returns></returns>

AddCellValueCondition

<summary>: Add new cell value condition to the collection.

</summary> <param name=”operatorType”>The Comparison operator for conditional formatting in Excel.</param> <param name=”value1”>The first value</param> <param name=”value2”>The second value .If the operatorTypy is Equal or NotEqual or Greater or Less or GreaterOrEqual or LessOrEqual,

then this parameter must use string.Empty or null</param>

AddCells

AddCondition() → IConditionalFormat

AddContainsBlanksCondition() → IConditionalFormat

<summary>: Add new contain blanks condition to the collection.

</summary> <returns></returns>

AddContainsErrorsCondition() → IConditionalFormat

<summary>: Add new contain errors condition to the collection.

</summary> <returns></returns>

AddContainsTextCondition(text: str) → IConditionalFormat

<summary>: Add new contain condition to the collection.

</summary> <param name=”text”>contain text</param> <returns></returns>

AddDuplicateValuesCondition() → IConditionalFormat

<summary>: Add new duplicate values condition to the collection.

</summary> <returns></returns>

AddEndsWithCondition(text: str) → IConditionalFormat

<summary>: Add new end with condition to the collection.

</summary> <param name=”text”>end with text</param> <returns></returns>

AddNotContainsBlanksCondition() → IConditionalFormat

<summary>: Add new not contain blanks condition to the collection.

</summary> <returns></returns>

AddNotContainsErrorsCondition() → IConditionalFormat

<summary>: Add new not contain errors condition to the collection.

</summary> <returns></returns>

AddNotContainsTextCondition(text: str) → IConditionalFormat

<summary>: Add new not contain condition to the collection.

</summary> <param name=”text”>not contain text</param> <returns></returns>

AddRange(range: IXLSRange)

AddTimePeriodCondition(timePeriodType: TimePeriodType) → IConditionalFormat

<summary>: Add new time period condition to the collection.

</summary> <param name=”timePeriodType”>type of the time period</param> <returns></returns>

AddTopBottomCondition(topBottomType: TopBottomType, rank: int) → IConditionalFormat

<summary>: Add new TopN or BottomN condition to the collection.

</summary> <param name=”TopBottomType”>type of the Top or Bottom</param> <param name=”rank”>rank of the Top or Bottom</param> <returns></returns>

AddUniqueValuesCondition() → IConditionalFormat

<summary>: Add new unique values condition to the collection.

</summary> <returns></returns>

property Address: str

property AddressR1C1: str

BeginUpdate()

property Capacity: int

Clear()

ClearCells()

Clone(parent: SpireObject) → SpireObject

CompareFormats(firstFormat: IConditionalFormat, secondFormat: IConditionalFormat) → bool

CompareTo(formats: XlsConditionalFormats) → bool

ContainsCount(range: Rectangle) → int

property Count: int

EndUpdate()

Equals(obj: SpireObject) → bool

GetByIndex(index: int) → IConditionalFormat

GetEnumerator() → IEnumerator

GetHashCode() → int

property IsEmpty: bool

static MAXIMUM_CF_NUMBER() → int

Remove

RemoveAt(index: int)

get_Item(fieldIndex: int) → IConditionalFormat