com.spire.xls
Class ConditionalFormatWrapper

java.lang.Object
  com.spire.xls.core.spreadsheet.CommonWrapper
      com.spire.xls.ConditionalFormatWrapper

All Implemented Interfaces:

IConditionalFormat, IOptimizedUpdate

public class ConditionalFormatWrapper
extends CommonWrapper
implements IConditionalFormat

Summary description for conditional format wrapper.

Constructor Summary

ConditionalFormatWrapper(CondFormatCollectionWrapper formats, int iIndex)
Creates new instance of the wrapper.

Method Summary

Average	getAverage()
java.awt.Color	getBackColor() Gets Pattern background color.
OColor	getBackColorObject() Gets conditional format background color.
ExcelColors	getBackKnownColor() Gets pattern background color.
java.awt.Color	getBottomBorderColor() Gets color of the bottom line
OColor	getBottomBorderColorObject() Gets conditional format bottom border color.
ExcelColors	getBottomBorderKnownColor() Gets color of the bottom line.
LineStyleType	getBottomBorderStyle() Gets bottom border line style.
java.awt.Color	getColor() Gets pattern foreground color.
ColorScale	getColorScale() Returns color scale settings.
DataBar	getDataBar() Returns data bar settings.
int	getDxfId()
ExcelPatternType	getFillPattern() Gets xls fill pattern style.
java.lang.String	getFirstFormula() Gets first formula.
java.lang.String	getFirstFormulaR1C1() Gets first formula.
java.awt.Color	getFontColor() Gets font color.
com.spire.ms.System.Drawing.Color	getFontColorInner() Gets font color.
OColor	getFontColorObject() Gets conditional format font color.
ExcelColors	getFontKnownColor() Gets font color.
ConditionalFormatType	getFormatType() Gets type of the conditional format.
IconSet	getIconSet() Returns iconset settings.
com.spire.ms.System.Drawing.Color	getInnerTopBorderColor() Gets color of the top line
ExcelColors	getKnownColor() Gets pattern foreground color.
java.awt.Color	getLeftBorderColor() Gets color of the left line.
OColor	getLeftBorderColorObject() Conditional format left border color.
ExcelColors	getLeftBorderKnownColor() Gets color of the left line.
LineStyleType	getLeftBorderStyle() Gets left border line style.
java.lang.String	getNumberFormat()
OColor	getOColor() Gets conditional format color.
ComparisonOperatorType	getOperator() Gets type of the comparison operator.
java.lang.Object	getParent() Gets parent object for this object.
int	getPriority() Priority.
java.awt.Color	getRightBorderColor() Gets color of the right line.
ExcelColors	getRightBorderKnownColor() Gets color of the right line.
LineStyleType	getRightBorderStyle() Gets right border line style.
java.lang.String	getSecondFormula() Gets second formula.
java.lang.String	getSecondFormulaR1C1() Gets first formula.
boolean	getStopIfTrue()
java.awt.Color	getTopBorderColor() Gets color of the top line
OColor	getTopBorderColorObject() Gets conditional format top border color.
ExcelColors	getTopBorderKnownColor() Gets color of the top line.
LineStyleType	getTopBorderStyle() Gets top border line style.
TopBottom	getTopBottom()
FontUnderlineType	getUnderline() Gets underline type.
boolean	isBackgroundColorPresent() Gets if true - background color present.
void	isBackgroundColorPresent(boolean flag) Sets if true - background color present.
boolean	isBold() Indicates whether the font is bold.
void	isBold(boolean isBold) Sets whether the font is bold.
boolean	isBorderFormatPresent() Gets if contains border formatting.
void	isBorderFormatPresent(boolean value) Sets if contains border formatting.
boolean	isFontColorPresent() If true - format color present.
void	isFontColorPresent(boolean value) If true - format color present.
boolean	isFontFormatPresent() True if contains font formatting.
void	isFontFormatPresent(boolean value) Sets if contains font formatting.
boolean	isItalic() Indicates whether font is italic.
void	isItalic(boolean isItalic) Sets whether font is italic.
boolean	isPatternColorPresent() Indicates whether pattern color .
void	isPatternColorPresent(boolean value) Sets whether pattern color .
boolean	isPatternFormatPresent() True if contains pattern formatting.
void	isPatternFormatPresent(boolean value) True if contains pattern formatting.
boolean	isStrikeThrough() Indicates whether font is struck through.
void	isStrikeThrough(boolean flag) Sets whether font is struck through.
boolean	isSubScript() Indicates whether font is subscript.
void	isSubScript(boolean isSubScript) Sets whether font is subscript.
boolean	isSuperScript() Indicates whether font is superscript.
void	isSuperScript(boolean isSuperScript) Sets whether font is superscript.
java.lang.String	makeFormula()
java.lang.String	makeFormula(java.lang.String para)
void	setBackColor(java.awt.Color backColor) Sets Pattern background color.
void	setBackKnownColor(ExcelColors backKnownColor) Sets pattern background color.
void	setBottomBorderColor(java.awt.Color bottomBorderColor) Sets color of the bottom line
void	setBottomBorderKnownColor(ExcelColors bottomBorderKnownColor) Sets color of the bottom line.
void	setBottomBorderStyle(LineStyleType bottomBorderStyle) Sets bottom border line style.
void	setColor(java.awt.Color color) Sets pattern foreground color.
void	setDxfId(int dxfId)
void	setFillPattern(ExcelPatternType fillPattern) Sets xls fill pattern style.
void	setFirstFormula(java.lang.String firstFormula) Sets first formula.
void	setFirstFormulaR1C1(java.lang.String firstFormulaR1C1) Sets first formula.
void	setFontColor(java.awt.Color fontColor) Sets font color.
void	setFontKnownColor(ExcelColors fontKnownColor) Sets font color.
void	setFormatType(ConditionalFormatType formatType) Sets type of the conditional format.
void	setKnownColor(ExcelColors knownColor) Sets pattern foreground color.
void	setLeftBorderColor(java.awt.Color leftBorderColor) Sets color of the left line.
void	setLeftBorderKnownColor(ExcelColors leftBorderKnownColor) Sets color of the left line.
void	setLeftBorderStyle(LineStyleType leftBorderStyle) Sets left border line style.
void	setNumberFormat(java.lang.String numberFormat)
void	setOperator(ComparisonOperatorType operator) Sets type of the comparison operator.
void	setPriority(int priority) Priority.
void	setRightBorderColor(java.awt.Color rightBorderColor) Color of the right line.
void	setRightBorderKnownColor(ExcelColors rightBorderKnownColor) Sets color of the right line.
void	setRightBorderStyle(LineStyleType rightBorderStyle) Sets right border line style.
void	setSecondFormula(java.lang.String secondFormula) Sets second formula.
void	setSecondFormulaR1C1(java.lang.String secondFormulaR1C1) Sets first formula.
void	setStopIfTrue(boolean stopIfTrue)
void	setTimePeriod(TimePeriodType timePeriod)
void	setTopBorderColor(java.awt.Color topBorderColor) Sets color of the top line
void	setTopBorderKnownColor(ExcelColors topBorderKnownColor) Sets color of the top line.
void	setTopBorderStyle(LineStyleType topBorderStyle) Sets top border line style.
void	setUnderline(FontUnderlineType underline) Sets underline type.

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

beginUpdate, endUpdate

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

getBackColorInner, setBackColor, setFontColor

Constructor Detail

ConditionalFormatWrapper

public ConditionalFormatWrapper(CondFormatCollectionWrapper formats,
                                int iIndex)

Creates new instance of the wrapper.

Parameters:

formats - Parent formats collection.

iIndex - Condition index.

Method Detail

getParent

public java.lang.Object getParent()

Gets parent object for this object.

getPriority

public int getPriority()

Description copied from interface: IConditionalFormat

Priority.

Specified by:

getPriority in interface IConditionalFormat

setPriority

public void setPriority(int priority)

Description copied from interface: IConditionalFormat

Priority.

Specified by:

setPriority in interface IConditionalFormat

getTopBottom

public TopBottom getTopBottom()

getAverage

public Average getAverage()

getFormatType

public ConditionalFormatType getFormatType()

Gets type of the conditional format.

Specified by:

getFormatType in interface IConditionalFormat

Returns:

setFormatType

public void setFormatType(ConditionalFormatType formatType)

Sets type of the conditional format.

Specified by:

setFormatType in interface IConditionalFormat

getStopIfTrue

public boolean getStopIfTrue()

setStopIfTrue

public void setStopIfTrue(boolean stopIfTrue)

getOperator

public ComparisonOperatorType getOperator()

Gets type of the comparison operator.

Specified by:

getOperator in interface IConditionalFormat

Returns:

setOperator

public void setOperator(ComparisonOperatorType operator)

Sets type of the comparison operator.

Specified by:

setOperator in interface IConditionalFormat

isBold

public boolean isBold()

Indicates whether the font is bold.

Specified by:

isBold in interface IConditionalFormat

isBold

public void isBold(boolean isBold)

Sets whether the 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 isItalic)

Sets whether font is italic.

Specified by:

isItalic in interface IConditionalFormat

getFontKnownColor

public ExcelColors getFontKnownColor()

Gets font color.

Specified by:

getFontKnownColor in interface IConditionalFormat

setFontKnownColor

public void setFontKnownColor(ExcelColors fontKnownColor)

Sets font color.

Specified by:

setFontKnownColor in interface IConditionalFormat

getFontColorInner

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

Gets font color.

Specified by:

getFontColorInner in interface IConditionalFormat

getFontColor

public java.awt.Color getFontColor()

Gets font color.

Specified by:

getFontColor in interface IConditionalFormat

Returns:

setFontColor

public void setFontColor(java.awt.Color fontColor)

Description copied from interface: IConditionalFormat

Sets font color.

Specified by:

setFontColor in interface IConditionalFormat

getUnderline

public FontUnderlineType getUnderline()

Gets underline type.

Specified by:

getUnderline in interface IConditionalFormat

setUnderline

public void setUnderline(FontUnderlineType underline)

Sets underline type.

isStrikeThrough

public boolean isStrikeThrough()

Indicates whether font is struck through.

Specified by:

isStrikeThrough in interface IConditionalFormat

isStrikeThrough

public void isStrikeThrough(boolean flag)

Sets whether font is struck through.

Specified by:

isStrikeThrough in interface IConditionalFormat

getLeftBorderKnownColor

public ExcelColors getLeftBorderKnownColor()

Gets color of the left line.

Specified by:

getLeftBorderKnownColor in interface IConditionalFormat

setLeftBorderKnownColor

public void setLeftBorderKnownColor(ExcelColors leftBorderKnownColor)

Sets color of the left line.

Specified by:

setLeftBorderKnownColor in interface IConditionalFormat

getLeftBorderColor

public java.awt.Color getLeftBorderColor()

Gets color of the left line.

Specified by:

getLeftBorderColor in interface IConditionalFormat

setLeftBorderColor

public void setLeftBorderColor(java.awt.Color leftBorderColor)

Sets color of the left line.

Specified by:

setLeftBorderColor in interface IConditionalFormat

Parameters:

leftBorderColor -

getLeftBorderStyle

public LineStyleType getLeftBorderStyle()

Gets left border line style.

Specified by:

getLeftBorderStyle in interface IConditionalFormat

setLeftBorderStyle

public void setLeftBorderStyle(LineStyleType leftBorderStyle)

Sets left border line style.

Specified by:

setLeftBorderStyle in interface IConditionalFormat

getRightBorderKnownColor

public ExcelColors getRightBorderKnownColor()

Gets color of the right line.

Specified by:

getRightBorderKnownColor in interface IConditionalFormat

setRightBorderKnownColor

public void setRightBorderKnownColor(ExcelColors rightBorderKnownColor)

Sets color of the right line.

Specified by:

setRightBorderKnownColor in interface IConditionalFormat

getRightBorderColor

public java.awt.Color getRightBorderColor()

Gets color of the right line.

Specified by:

getRightBorderColor in interface IConditionalFormat

Returns:

Color of the right line.

setRightBorderColor

public void setRightBorderColor(java.awt.Color rightBorderColor)

Color of the right line.

Specified by:

setRightBorderColor in interface IConditionalFormat

getRightBorderStyle

public LineStyleType getRightBorderStyle()

Gets right border line style.

Specified by:

getRightBorderStyle in interface IConditionalFormat

setRightBorderStyle

public void setRightBorderStyle(LineStyleType rightBorderStyle)

Sets right border line style.

Specified by:

setRightBorderStyle in interface IConditionalFormat

getTopBorderKnownColor

public ExcelColors getTopBorderKnownColor()

Gets color of the top line.

Specified by:

getTopBorderKnownColor in interface IConditionalFormat

setTopBorderKnownColor

public void setTopBorderKnownColor(ExcelColors topBorderKnownColor)

Sets color of the top line.

Specified by:

setTopBorderKnownColor in interface IConditionalFormat

getInnerTopBorderColor

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

Gets color of the top line

getTopBorderColor

public java.awt.Color getTopBorderColor()

Gets color of the top line

Specified by:

getTopBorderColor in interface IConditionalFormat

Returns:

Color of the top line

setTopBorderColor

public void setTopBorderColor(java.awt.Color topBorderColor)

Sets color of the top line

Specified by:

setTopBorderColor in interface IConditionalFormat

Parameters:

topBorderColor - Color of the top line

getTopBorderStyle

public LineStyleType getTopBorderStyle()

Gets top border line style.

Specified by:

getTopBorderStyle in interface IConditionalFormat

setTopBorderStyle

public void setTopBorderStyle(LineStyleType topBorderStyle)

Sets top border line style.

Specified by:

setTopBorderStyle in interface IConditionalFormat

getBottomBorderKnownColor

public ExcelColors getBottomBorderKnownColor()

Gets color of the bottom line.

Specified by:

getBottomBorderKnownColor in interface IConditionalFormat

setBottomBorderKnownColor

public void setBottomBorderKnownColor(ExcelColors bottomBorderKnownColor)

Sets color of the bottom line.

Specified by:

setBottomBorderKnownColor in interface IConditionalFormat

getBottomBorderColor

public java.awt.Color getBottomBorderColor()

Gets color of the bottom line

Specified by:

getBottomBorderColor in interface IConditionalFormat

Returns:

Color of the bottom line

setBottomBorderColor

public void setBottomBorderColor(java.awt.Color bottomBorderColor)

Sets color of the bottom line

Specified by:

setBottomBorderColor in interface IConditionalFormat

getBottomBorderStyle

public LineStyleType getBottomBorderStyle()

Gets bottom border line style.

Specified by:

getBottomBorderStyle in interface IConditionalFormat

Returns:

setBottomBorderStyle

public void setBottomBorderStyle(LineStyleType bottomBorderStyle)

Sets bottom border line style.

Specified by:

setBottomBorderStyle in interface IConditionalFormat

getFirstFormula

public java.lang.String getFirstFormula()

Gets first formula.

Specified by:

getFirstFormula in interface IConditionalFormat

Returns:

setFirstFormula

public void setFirstFormula(java.lang.String firstFormula)

Sets first formula.

Specified by:

setFirstFormula in interface IConditionalFormat

getFirstFormulaR1C1

public java.lang.String getFirstFormulaR1C1()

Gets first formula.

setFirstFormulaR1C1

public void setFirstFormulaR1C1(java.lang.String firstFormulaR1C1)

Sets first formula.

getSecondFormulaR1C1

public java.lang.String getSecondFormulaR1C1()

Gets first formula.

setSecondFormulaR1C1

public void setSecondFormulaR1C1(java.lang.String secondFormulaR1C1)

Sets first formula.

getSecondFormula

public java.lang.String getSecondFormula()

Gets second formula.

Specified by:

getSecondFormula in interface IConditionalFormat

setSecondFormula

public void setSecondFormula(java.lang.String secondFormula)

Sets second formula.

Specified by:

setSecondFormula in interface IConditionalFormat

getKnownColor

public ExcelColors getKnownColor()

Gets pattern foreground color.

Specified by:

getKnownColor in interface IConditionalFormat

setKnownColor

public void setKnownColor(ExcelColors knownColor)

Sets pattern foreground color.

Specified by:

setKnownColor in interface IConditionalFormat

getColor

public java.awt.Color getColor()

Gets pattern foreground color.

Specified by:

getColor in interface IConditionalFormat

setColor

public void setColor(java.awt.Color color)

Sets pattern foreground color.

Specified by:

setColor in interface IConditionalFormat

getBackKnownColor

public ExcelColors getBackKnownColor()

Gets pattern background color.

Specified by:

getBackKnownColor in interface IConditionalFormat

setBackKnownColor

public void setBackKnownColor(ExcelColors backKnownColor)

Sets pattern background color.

Specified by:

setBackKnownColor in interface IConditionalFormat

getBackColor

public java.awt.Color getBackColor()

Gets Pattern background color.

Specified by:

getBackColor in interface IConditionalFormat

Returns:

setBackColor

public void setBackColor(java.awt.Color backColor)

Sets Pattern background color.

Specified by:

setBackColor in interface IConditionalFormat

Parameters:

backColor -

getFillPattern

public ExcelPatternType getFillPattern()

Gets xls fill pattern style.

Specified by:

getFillPattern in interface IConditionalFormat

setFillPattern

public void setFillPattern(ExcelPatternType fillPattern)

Sets xls fill pattern style.

Specified by:

setFillPattern in interface IConditionalFormat

isSuperScript

public boolean isSuperScript()

Indicates whether font is superscript.

Specified by:

isSuperScript in interface IConditionalFormat

isSuperScript

public void isSuperScript(boolean isSuperScript)

Sets 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 isSubScript)

Sets whether font is subscript.

Specified by:

isSubScript in interface IConditionalFormat

getNumberFormat

public java.lang.String getNumberFormat()

setNumberFormat

public void setNumberFormat(java.lang.String numberFormat)

getColorScale

public ColorScale getColorScale()

Returns color scale settings. Valid only if format type is set to color scale. Read-only.

Specified by:

getColorScale in interface IConditionalFormat

getDataBar

public DataBar getDataBar()

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 format type is set to icon set. Read-only.

Specified by:

getIconSet in interface IConditionalFormat

makeFormula

public java.lang.String makeFormula()

makeFormula

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

setTimePeriod

public void setTimePeriod(TimePeriodType timePeriod)

getOColor

public OColor getOColor()

Gets conditional format color. Read-only.

getBackColorObject

public OColor getBackColorObject()

Gets conditional format background color. Read-only.

getTopBorderColorObject

public OColor getTopBorderColorObject()

Gets conditional format top border color. Read-only.

getBottomBorderColorObject

public OColor getBottomBorderColorObject()

Gets conditional format bottom border color. Read-only.

getLeftBorderColorObject

public OColor getLeftBorderColorObject()

Conditional format left border color. Read-only.

getFontColorObject

public OColor getFontColorObject()

Gets conditional format font color. Read-only.

isBackgroundColorPresent

public boolean isBackgroundColorPresent()

Gets if true - background color present. otherwise - false.

isBackgroundColorPresent

public void isBackgroundColorPresent(boolean flag)

Sets if true - background color present. otherwise - false.

isBorderFormatPresent

public boolean isBorderFormatPresent()

Gets if contains border formatting.

isBorderFormatPresent

public void isBorderFormatPresent(boolean value)

Sets if contains border formatting.

isFontColorPresent

public boolean isFontColorPresent()

If true - format color present. otherwise - false.

isFontColorPresent

public void isFontColorPresent(boolean value)

If true - format color present. otherwise - false.

isFontFormatPresent

public boolean isFontFormatPresent()

True if contains font formatting.

isFontFormatPresent

public void isFontFormatPresent(boolean value)

Sets if contains font formatting.

isPatternColorPresent

public boolean isPatternColorPresent()

Indicates whether pattern color .

isPatternColorPresent

public void isPatternColorPresent(boolean value)

Sets whether pattern color .

isPatternFormatPresent

public boolean isPatternFormatPresent()

True if contains pattern formatting.

isPatternFormatPresent

public void isPatternFormatPresent(boolean value)

True if contains pattern formatting.

getDxfId

public int getDxfId()

setDxfId

public void setDxfId(int dxfId)