xlsconditionalformats-ag凯发旗舰厅

com.spire.xls.core.spreadsheet.collections
class xlsconditionalformats

java.lang.object
  com.spire.ms.system.collections.collectionbase
      
          com.spire.xls.core.spreadsheet.collections.xlsconditionalformats

all implemented interfaces:

com.spire.ms.system.collections.icollection, com.spire.ms.system.collections.ienumerable, iconditionalformats, java.lang.iterable

public class xlsconditionalformats
extends 
implements iconditionalformats

collection of conditional formats for the single-cell range.

xlsconditionalformats

public xlsconditionalformats(java.lang.object parent,
                              fcc)

creates new instance.

parameters:

parent - parent object.

xlsconditionalformats

public xlsconditionalformats(java.lang.object parent,
                             xlsconditionalformats toclone)

creates new instance.

parameters:

parent - parent object.

toclone - collection to clone.

addcondition

public iconditionalformat addcondition()

adds new condition to the collection.

specified by:

addcondition in interface iconditionalformats

returns:

addcellvaluecondition

public iconditionalformat addcellvaluecondition(comparisonoperatortype operatortype,
                                                java.lang.string value1,
                                                java.lang.string value2)

add new cell value condition to the collection.

parameters:

operatortype - the comparison operator for conditional formatting in excel.

value1 - the first value

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

returns:

addcellvaluecondition

public iconditionalformat addcellvaluecondition(comparisonoperatortype operatortype,
                                                double value1,
                                                double value2)

add new cell value condition to the collection.

parameters:

operatortype - the comparison operator for conditional formatting in excel.

value1 - the first value

value2 - the second value.if the operatortypy is equal or notequal or greater or less or greaterorequal or lessorequal, then this parameter must use ***double.nan***.don't use null

returns:

addbeginswithcondition

public iconditionalformat addbeginswithcondition(java.lang.string text)

add new begin with condition to the collection.

parameters:

text - begin with text

returns:

addcontainstextcondition

public iconditionalformat addcontainstextcondition(java.lang.string text)

add new contain condition to the collection.

parameters:

text - contain text

returns:

addendswithcondition

public iconditionalformat addendswithcondition(java.lang.string text)

add new end with condition to the collection.

parameters:

text - end with text

returns:

addnotcontainstextcondition

public iconditionalformat addnotcontainstextcondition(java.lang.string text)

add new not contain condition to the collection.

parameters:

text - not contain text

returns:

addcontainsblankscondition

public iconditionalformat addcontainsblankscondition()

add new contain blanks condition to the collection.

returns:

addcontainserrorscondition

public iconditionalformat addcontainserrorscondition()

add new contain errors condition to the collection.

returns:

addduplicatevaluescondition

public iconditionalformat addduplicatevaluescondition()

add new duplicate values condition to the collection.

returns:

addnotcontainsblankscondition

public iconditionalformat addnotcontainsblankscondition()

add new not contain blanks condition to the collection.

returns:

addnotcontainserrorscondition

public iconditionalformat addnotcontainserrorscondition()

add new not contain errors condition to the collection.

returns:

adduniquevaluescondition

public iconditionalformat adduniquevaluescondition()

add new unique values condition to the collection.

returns:

addtimeperiodcondition

public iconditionalformat addtimeperiodcondition(timeperiodtype timeperiodtype)

add new time period condition to the collection.

parameters:

timeperiodtype - type of the time period

returns:

addaveragecondition

public iconditionalformat addaveragecondition(averagetype averagetype)

add new above or below the average condition to the collection.

parameters:

averagetype - type of the average

returns:

addtopbottomcondition

public iconditionalformat addtopbottomcondition(topbottomtype topbottomtype,
                                                int rank)

add new topn or bottomn condition to the collection.

parameters:

topbottomtype - type of the top or bottom

rank - rank of the top or bottom

returns:

remove

public void remove(int startrow,
                   int startcolumn,
                   int totalrows,
                   int totalcolumns)

removes the condtional format at the specified range

parameters:

startrow - the startrow of the range.

startcolumn - the startcolumn of the range.

totalrows - the number of rows of the range.

totalcolumns - the number of columns of the range.

removeat

public void removeat(int index)

removes the condtional format at the specified index

specified by:

removeat in interface iconditionalformats

overrides:

removeat in class com.spire.ms.system.collections.collectionbase

parameters:

index - the index of the formatting condition to be removed.

compareto

public boolean compareto(xlsconditionalformats formats)

compares this collection to another.

parameters:

formats - collection to compare.

returns:

true if collections are equal.

addcells

public void addcells(xlsconditionalformats formats)

adds cells from the collection.

parameters:

formats - formats collection to get cells from.

contains

public boolean contains(java.awt.rectangle[] arrranges)

indicates whether collection contains all specified ranges.

parameters:

arrranges - ranges to check.

returns:

true if collection contains all specified ranges.

containscount

public int containscount(com.spire.ms.system.drawing.rectangle range)

returns contains count for specified range.

parameters:

range - range to check.

returns:

contains count

addcells

public void addcells(com.spire.ms.system.collections.ilist arrcells)

adds cells from the collection.

parameters:

arrcells - cells to add to the collection. public void addrectangles( ilist arrcells )

addrange

public void addrange(ixlsrange range)

adds range to the collection.

parameters:

range - range to add.

remove

public void remove(java.awt.rectangle[] arrranges)

removes range from the collection of conditional formats.

parameters:

arrranges - array of ranges to remove.

clearcells

public void clearcells()

removes all cells from the collection.

hashcode

public int hashcode()

serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.

overrides:

hashcode in class java.lang.object

returns:

a hash code for the current object.

equals

public boolean equals(java.lang.object obj)

a hash code for the current object without taking cell list into account.

overrides:

equals in class java.lang.object

parameters:

obj - the object to compare with the current object.

returns:

deepclone

public java.lang.object deepclone(java.lang.object parent)

creates a new object that is a copy of the current instance.

overrides:

in class

parameters:

parent - parent object for a copy of this instance.

returns:

a new object that is a copy of this instance.

isempty

public boolean isempty()

indicates whether collection is empty. read-only.

getaddress

public java.lang.string getaddress()

represents address of cf ranges.

getaddressr1c1

public java.lang.string getaddressr1c1()

represents address of cf ranges in r1c1 notation.

getcellrectangles

public java.util.arraylist getcellrectangles()

gets list of rectangles describing cells with conditional formatting.

getbyindex

public iconditionalformat getbyindex(int index)

returns a single filter object from a collection.

get

public iconditionalformat get(int fieldindex)

gets object at the special field.

specified by:

get in interface iconditionalformats

parameters:

fieldindex - the integer offset of the field on which you want to base the filter (from the left of the list; the leftmost field is field 0).

returns:

returens object.

getcapacity

public int getcapacity()

overrides:

getcapacity in class com.spire.ms.system.collections.collectionbase

setcapacity

public void setcapacity(int value)

overrides:

setcapacity in class com.spire.ms.system.collections.collectionbase

getcount

public int getcount()

description copied from interface: iconditionalformats

returns number of elements in the collection. read-only.

specified by:

getcount in interface iconditionalformats