com.spire.xls.core.spreadsheet
Class XlsConditionalFormat

java.lang.Object
  com.spire.xls.core.spreadsheet.XlsObject
      com.spire.xls.core.spreadsheet.XlsConditionalFormat

All Implemented Interfaces:

IConditionalFormat

Direct Known Subclasses:

ConditionalFormat

public class XlsConditionalFormat
extends XlsObject
implements IConditionalFormat

Contains a condition and the formatting for cells.

Constructor Summary

XlsConditionalFormat(java.lang.Object parent)
Creates ConditionalFormat and set its ReservedHandle and Parent properties to speicified values.

XlsConditionalFormat(java.lang.Object parent, FormatCondition fc)

Method Summary

java.lang.Object	deepClone(java.lang.Object parent) Creates a new object that is a copy of the current instance.
boolean	equals(java.lang.Object obj) A hash code for the current Object without taking cell list into account.
Average	getAverage() Get the conditional formatting's "Average" instance.
java.awt.Color	getBackColor() get Pattern background color.
OColor	getBackColorObject() Conditional format background color.
ExcelColors	getBackKnownColor() Pattern background excel color.
java.awt.Color	getBottomBorderColor() Color of the bottom line.
OColor	getBottomBorderColorObject() Conditional format bottom border color.
ExcelColors	getBottomBorderKnownColor() Excel color of the bottom line.
LineStyleType	getBottomBorderStyle() Bottom border line style.
java.awt.Color	getColor() Pattern foreground color.
ColorScale	getColorScale() Get the conditional formatting's "ColorScale" instance.
DataBar	getDataBar() Returns data bar settings.
int	getDxfId()
ExcelPatternType	getFillPattern() XlsFill pattern type.
java.lang.String	getFirstFormula() First formula.
java.awt.Color	getFontColor() get Font color.
com.spire.ms.System.Drawing.Color	getFontColorInner() Font color.
OColor	getFontColorObject() Conditional format font color.
ExcelColors	getFontKnownColor() Font excel color.
ConditionalFormatType	getFormatType() conditional format type.
IconSet	getIconSet() Returns iconset settings.
ExcelColors	getKnownColor() Pattern foreground excel color.
java.awt.Color	getLeftBorderColor() Color of the left line.
OColor	getLeftBorderColorObject() Conditional format left border color.
ExcelColors	getLeftBorderKnownColor() Excel color of the left line.
LineStyleType	getLeftBorderStyle() Left border line style.
java.lang.String	getNumberFormat()
OColor	getOColor() Conditional format color.
ComparisonOperatorType	getOperator() Type of the comparison operator.
int	getPriority() Priority.
java.awt.Color	getRightBorderColor() Color of the right line.
OColor	getRightBorderColorObject() Conditional format right border color.
ExcelColors	getRightBorderKnownColor() Color of the right line.
LineStyleType	getRightBorderStyle() Right border line style.
java.lang.String	getSecondFormula() Second formula.
boolean	getStopIfTrue() True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.
java.awt.Color	getTopBorderColor() Color of the top line.
OColor	getTopBorderColorObject() Conditional format top border color.
ExcelColors	getTopBorderKnownColor() Excel color of the top line.
LineStyleType	getTopBorderStyle() Top border line style.
TopBottom	getTopBottom() Get the conditional formatting's "TopBottom" instance.
FontUnderlineType	getUnderline() Underline type.
int	hashCode() Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
boolean	isBold() Indicates whether font is bold.
void	isBold(boolean value) Indicates whether font is bold.
boolean	isBorderFormatPresent() Indicates whether contains border formatting.
void	isBorderFormatPresent(boolean value) Indicates whether contains border formatting.
boolean	isFontFormatPresent() Indicates whether contains font formatting.
void	isFontFormatPresent(boolean value) Indicates whether contains font formatting.
boolean	isItalic() Indicates whether font is italic.
void	isItalic(boolean value) Indicates whether font is italic.
boolean	isNumberFormatPresent()
boolean	isPatternFormatPresent() Indicates whether contains pattern formatting.
void	isPatternFormatPresent(boolean value) Indicates whether contains pattern formatting.
boolean	isStrikeThrough() Indicates whether font is striked through.
void	isStrikeThrough(boolean value) Indicates whether font is striked through.
boolean	isSubScript() Indicates whether font is subscript.
void	isSubScript(boolean value) Indicates whether font is subscript.
boolean	isSuperScript() Indicates whether font is superscript.
void	isSuperScript(boolean value) Indicates whether font is superscript.
java.lang.String	makeFormula()
java.lang.String	makeFormula(double para)
java.lang.String	makeFormula(java.lang.String para)
void	setBackColor(java.awt.Color value) set Pattern background color.
void	setBackKnownColor(ExcelColors value) Pattern background excel color.
void	setBottomBorderColor(java.awt.Color value) Color of the bottom line.
void	setBottomBorderKnownColor(ExcelColors value) Excel color of the bottom line.
void	setBottomBorderStyle(LineStyleType value) Bottom border line style.
void	setColor(java.awt.Color value) Pattern foreground color.
void	setDxfId(int value)
void	setFillPattern(ExcelPatternType value) XlsFill pattern type.
void	setFirstFormula(java.lang.String value) First formula.
void	setFontColor(java.awt.Color value) set Font color.
void	setFontKnownColor(ExcelColors value) Font excel color.
void	setFormatType(ConditionalFormatType value) conditional format type.
void	setKnownColor(ExcelColors value) Pattern foreground excel color.
void	setLeftBorderColor(com.spire.ms.System.Drawing.Color value) Color of the left line.
void	setLeftBorderColor(java.awt.Color value) set Color of the left line.
void	setLeftBorderKnownColor(ExcelColors value) Excel color of the left line.
void	setLeftBorderStyle(LineStyleType value) Left border line style.
void	setNumberFormat(java.lang.String value)
void	setOperator(ComparisonOperatorType value) Type of the comparison operator.
void	setPriority(int value) Priority.
void	setRightBorderColor(java.awt.Color value) Color of the right line.
void	setRightBorderKnownColor(ExcelColors value) Color of the right line.
void	setRightBorderStyle(LineStyleType value) Right border line style.
void	setSecondFormula(java.lang.String value) Second formula.
void	setStopIfTrue(boolean value) True, no rules with lower priority may be applied over this rule, when this rule evaluates to true.
void	setTimePeriod(TimePeriodType timePeriod)
void	setTopBorderColor(java.awt.Color value) Color of the top line.
void	setTopBorderKnownColor(ExcelColors value) Excel color of the top line.
void	setTopBorderStyle(LineStyleType value) Top border line style.
void	setUnderline(FontUnderlineType value) Underline type.

Methods inherited from class com.spire.xls.core.spreadsheet.XlsObject

dispose

Methods inherited from interface com.spire.xls.core.IConditionalFormat

getBackColorInner, setBackColor, setFontColor

Constructor Detail

XlsConditionalFormat

public XlsConditionalFormat(java.lang.Object parent)

Creates ConditionalFormat and set its ReservedHandle and Parent properties to speicified values.

Parameters:

parent - Parent object for the ConditionalFormat.

XlsConditionalFormat

public XlsConditionalFormat(java.lang.Object parent,
                            FormatCondition fc)

Method Detail

getPriority

public int getPriority()

Description copied from interface: IConditionalFormat

Priority.

Specified by:

getPriority in interface IConditionalFormat

setPriority

public void setPriority(int value)

Description copied from interface: IConditionalFormat

Priority.

Specified by:

setPriority in interface IConditionalFormat

getStopIfTrue

public boolean getStopIfTrue()

True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. Only applies for Excel 2007;

setStopIfTrue

public void setStopIfTrue(boolean value)

True, no rules with lower priority may be applied over this rule, when this rule evaluates to true. Only applies for Excel 2007;

getDxfId

public int getDxfId()

setDxfId

public void setDxfId(int value)

getAverage

public Average getAverage()

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.

Returns:

getTopBottom

public TopBottom getTopBottom()

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.

Returns:

getLeftBorderKnownColor

public ExcelColors getLeftBorderKnownColor()

Excel color of the left line.

Specified by:

getLeftBorderKnownColor in interface IConditionalFormat

setLeftBorderKnownColor

public void setLeftBorderKnownColor(ExcelColors value)

Excel color of the left line.

Specified by:

setLeftBorderKnownColor in interface IConditionalFormat

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

Color of the left line.

Specified by:

getLeftBorderColor in interface IConditionalFormat

setLeftBorderColor

public void setLeftBorderColor(com.spire.ms.System.Drawing.Color value)

Color of the left line.

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color value)

set Color of the left line.

Specified by:

setLeftBorderColor in interface IConditionalFormat

Parameters:

value -

getLeftBorderStyle

public LineStyleType getLeftBorderStyle()

Left border line style.

Specified by:

getLeftBorderStyle in interface IConditionalFormat

setLeftBorderStyle

public void setLeftBorderStyle(LineStyleType value)

Left border line style.

Specified by:

setLeftBorderStyle in interface IConditionalFormat

getRightBorderKnownColor

public ExcelColors getRightBorderKnownColor()

Color of the right line.

Specified by:

getRightBorderKnownColor in interface IConditionalFormat

setRightBorderKnownColor

public void setRightBorderKnownColor(ExcelColors value)

Color of the right line.

Specified by:

setRightBorderKnownColor in interface IConditionalFormat

getRightBorderColor

public java.awt.Color getRightBorderColor()

Color of the right line.

Specified by:

getRightBorderColor in interface IConditionalFormat

Returns:

Color of the right line.

setRightBorderColor

public void setRightBorderColor(java.awt.Color value)

Color of the right line.

Specified by:

setRightBorderColor in interface IConditionalFormat

getRightBorderStyle

public LineStyleType getRightBorderStyle()

Right border line style.

Specified by:

getRightBorderStyle in interface IConditionalFormat

setRightBorderStyle

public void setRightBorderStyle(LineStyleType value)

Right border line style.

Specified by:

setRightBorderStyle in interface IConditionalFormat

getTopBorderKnownColor

public ExcelColors getTopBorderKnownColor()

Excel color of the top line.

Specified by:

getTopBorderKnownColor in interface IConditionalFormat

setTopBorderKnownColor

public void setTopBorderKnownColor(ExcelColors value)

Excel color of the top line.

Specified by:

setTopBorderKnownColor in interface IConditionalFormat

getTopBorderColor

public java.awt.Color getTopBorderColor()

Color of the top line.

Specified by:

getTopBorderColor in interface IConditionalFormat

Returns:

Color of the top line.

setTopBorderColor

public void setTopBorderColor(java.awt.Color value)

Color of the top line.

Specified by:

setTopBorderColor in interface IConditionalFormat

Parameters:

value - Color of the top line.

getTopBorderStyle

public LineStyleType getTopBorderStyle()

Top border line style.

Specified by:

getTopBorderStyle in interface IConditionalFormat

setTopBorderStyle

public void setTopBorderStyle(LineStyleType value)

Top border line style.

Specified by:

setTopBorderStyle in interface IConditionalFormat

getBottomBorderKnownColor

public ExcelColors getBottomBorderKnownColor()

Excel color of the bottom line.

Specified by:

getBottomBorderKnownColor in interface IConditionalFormat

setBottomBorderKnownColor

public void setBottomBorderKnownColor(ExcelColors value)

Excel color of the bottom line.

Specified by:

setBottomBorderKnownColor in interface IConditionalFormat

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

Color of the bottom line.

Specified by:

getBottomBorderColor in interface IConditionalFormat

Returns:

Color of the bottom line.

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color value)

Color of the bottom line.

Specified by:

setBottomBorderColor in interface IConditionalFormat

getBottomBorderStyle

public LineStyleType getBottomBorderStyle()

Bottom border line style.

Specified by:

getBottomBorderStyle in interface IConditionalFormat

Returns:

setBottomBorderStyle

public void setBottomBorderStyle(LineStyleType value)

Bottom border line style.

Specified by:

setBottomBorderStyle in interface IConditionalFormat

getFirstFormula

public java.lang.String getFirstFormula()

First formula.

Specified by:

getFirstFormula in interface IConditionalFormat

Returns:

setFirstFormula

public void setFirstFormula(java.lang.String value)

First formula.

Specified by:

setFirstFormula in interface IConditionalFormat

setTimePeriod

public void setTimePeriod(TimePeriodType timePeriod)

getSecondFormula

public java.lang.String getSecondFormula()

Second formula.

Specified by:

getSecondFormula in interface IConditionalFormat

setSecondFormula

public void setSecondFormula(java.lang.String value)

Second formula.

Specified by:

setSecondFormula in interface IConditionalFormat

getFormatType

public ConditionalFormatType getFormatType()

conditional format type.

Specified by:

getFormatType in interface IConditionalFormat

Returns:

setFormatType

public void setFormatType(ConditionalFormatType value)

conditional format type.

Specified by:

setFormatType in interface IConditionalFormat

getOperator

public ComparisonOperatorType getOperator()

Type of the comparison operator.

Specified by:

getOperator in interface IConditionalFormat

Returns:

setOperator

public void setOperator(ComparisonOperatorType value)

Type of the comparison operator.

Specified by:

setOperator in interface IConditionalFormat

isBold

public boolean isBold()

Indicates whether font is bold.

Specified by:

isBold in interface IConditionalFormat

isBold

public void isBold(boolean value)

Indicates whether font is bold.

Specified by:

isBold in interface IConditionalFormat

isItalic

public boolean isItalic()

Indicates whether font is italic.

Specified by:

isItalic in interface IConditionalFormat

isItalic

public void isItalic(boolean value)

Indicates whether font is italic.

Specified by:

isItalic in interface IConditionalFormat

getFontKnownColor

public ExcelColors getFontKnownColor()

Font excel color.

Specified by:

getFontKnownColor in interface IConditionalFormat

setFontKnownColor

public void setFontKnownColor(ExcelColors value)

Font excel color.

Specified by:

setFontKnownColor in interface IConditionalFormat

getFontColorInner

public com.spire.ms.System.Drawing.Color getFontColorInner()

Font color.

Specified by:

getFontColorInner in interface IConditionalFormat

getFontColor

public java.awt.Color getFontColor()

get Font color.

Specified by:

getFontColor in interface IConditionalFormat

Returns:

setFontColor

public void setFontColor(java.awt.Color value)

set Font color.

Specified by:

setFontColor in interface IConditionalFormat

Parameters:

value -

getUnderline

public FontUnderlineType getUnderline()

Underline type.

Specified by:

getUnderline in interface IConditionalFormat

setUnderline

public void setUnderline(FontUnderlineType value)

Underline type.

isStrikeThrough

public boolean isStrikeThrough()

Indicates whether font is striked through.

Specified by:

isStrikeThrough in interface IConditionalFormat

isStrikeThrough

public void isStrikeThrough(boolean value)

Indicates whether font is striked through.

Specified by:

isStrikeThrough in interface IConditionalFormat

isSuperScript

public boolean isSuperScript()

Indicates whether font is superscript.

Specified by:

isSuperScript in interface IConditionalFormat

isSuperScript

public void isSuperScript(boolean value)

Indicates whether font is superscript.

Specified by:

isSuperScript in interface IConditionalFormat

isSubScript

public boolean isSubScript()

Indicates whether font is subscript.

Specified by:

isSubScript in interface IConditionalFormat

isSubScript

public void isSubScript(boolean value)

Indicates whether font is subscript.

Specified by:

isSubScript in interface IConditionalFormat

getKnownColor

public ExcelColors getKnownColor()

Pattern foreground excel color.

Specified by:

getKnownColor in interface IConditionalFormat

setKnownColor

public void setKnownColor(ExcelColors value)

Pattern foreground excel color.

Specified by:

setKnownColor in interface IConditionalFormat

getColor

public java.awt.Color getColor()

Pattern foreground color.

Specified by:

getColor in interface IConditionalFormat

setColor

public void setColor(java.awt.Color value)

Pattern foreground color.

Specified by:

setColor in interface IConditionalFormat

getBackKnownColor

public ExcelColors getBackKnownColor()

Pattern background excel color.

Specified by:

getBackKnownColor in interface IConditionalFormat

setBackKnownColor

public void setBackKnownColor(ExcelColors value)

Pattern background excel color.

Specified by:

setBackKnownColor in interface IConditionalFormat

getBackColor

public java.awt.Color getBackColor()

get Pattern background color.

Specified by:

getBackColor in interface IConditionalFormat

Returns:

setBackColor

public void setBackColor(java.awt.Color value)

set Pattern background color.

Specified by:

setBackColor in interface IConditionalFormat

Parameters:

value -

getFillPattern

public ExcelPatternType getFillPattern()

XlsFill pattern type.

Specified by:

getFillPattern in interface IConditionalFormat

setFillPattern

public void setFillPattern(ExcelPatternType value)

XlsFill pattern type.

Specified by:

setFillPattern in interface IConditionalFormat

isFontFormatPresent

public boolean isFontFormatPresent()

Indicates whether contains font formatting.

isFontFormatPresent

public void isFontFormatPresent(boolean value)

Indicates whether contains font formatting.

isBorderFormatPresent

public boolean isBorderFormatPresent()

Indicates whether contains border formatting.

isBorderFormatPresent

public void isBorderFormatPresent(boolean value)

Indicates whether contains border formatting.

isPatternFormatPresent

public boolean isPatternFormatPresent()

Indicates whether contains pattern formatting.

isPatternFormatPresent

public void isPatternFormatPresent(boolean value)

Indicates whether contains pattern formatting.

getDataBar

public DataBar getDataBar()

Description copied from interface: IConditionalFormat

Returns data bar settings. Valid only if format type is set to data bar. Read-only.

Specified by:

getDataBar in interface IConditionalFormat

getIconSet

public IconSet getIconSet()

Returns iconset settings. Valid only if FormatType is set to IconSet. Read-only.

Specified by:

getIconSet in interface IConditionalFormat

getColorScale

public ColorScale getColorScale()

Get the conditional formatting's "ColorScale" instance. The default instance is a "green-red" 2ColorScale . Valid only for type = ColorScale.

Specified by:

getColorScale in interface IConditionalFormat

Returns:

ColorScale instance

getNumberFormat

public java.lang.String getNumberFormat()

setNumberFormat

public void setNumberFormat(java.lang.String value)

isNumberFormatPresent

public boolean isNumberFormatPresent()

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.

Parameters:

parent - Parent object for a copy of this instance.

Returns:

A new object that is a copy of this instance.

getOColor

public OColor getOColor()

Conditional format color. Read-only.

getBackColorObject

public OColor getBackColorObject()

Conditional format background color. Read-only.

getTopBorderColorObject

public OColor getTopBorderColorObject()

Conditional format top border color. Read-only.

getBottomBorderColorObject

public OColor getBottomBorderColorObject()

Conditional format bottom border color. Read-only.

getLeftBorderColorObject

public OColor getLeftBorderColorObject()

Conditional format left border color. Read-only.

getRightBorderColorObject

public OColor getRightBorderColorObject()

Conditional format right border color. Read-only.

getFontColorObject

public OColor getFontColorObject()

Conditional format font color. Read-only.

makeFormula

public java.lang.String makeFormula()

makeFormula

public java.lang.String makeFormula(java.lang.String para)

makeFormula

public java.lang.String makeFormula(double para)