ActiveXLS
Class ExcelStyle

System.Object
  ActiveXLS.ExcelStyle

public class ExcelStyle

extends System.Object

This class stores the style information like font name, font size, font bold, font italic, word wrap, font underline style, font subscript, font superscript, font strikethrough, background color, foreground color, horizontal alignment, vertical alignment, number or date format, cell locked or hidden, shrink, border type, border color. A style can be assigned to a cell, column or a range of cells.

Constructor Summary

ExcelStyle()
Defines an instance of the style.

ExcelStyle(System.Drawing.Color background)
Defines an instance of the style that is initialized with background color.

ExcelStyle(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground)
Defines an instance of the style that is initialized with font settings.

ExcelStyle(System.String fontName, int fontSize, bool isBold, bool isItalic, System.Drawing.Color foreground, System.Drawing.Color background)
Defines an instance of the style that is initialized with font and background settings.

Method Summary

ExcelStyle	Clone() Creates and returns a copy of this object.
System.Drawing.Color	getBackground() Returns the background color of the style.
System.Drawing.Color	getBottomColor_Border() Returns the color of the bottom border.
int	getBottomStyle_Border() Returns the style of the bottom border.
System.String	getDataType() Returns the data type of the style.
System.String	getFont() Returns the name of the style font.
int	getFontSize() Returns the size of the style font.
System.Drawing.Color	getForeground() Returns the foreground color of the style.
System.String	getFormat() Returns the number/date format of the style.
System.String	getHorizontalAlignment() Returns the horizontal alignment of the style.
int	getIndent() Returns the indent of the style.
System.Drawing.Color	getLeftColor_Border() Returns the color of the left border.
int	getLeftStyle_Border() Returns the style of the left border.
int	getPattern() Returns the pattern of the style.
System.Drawing.Color	getPatternColor() Returns the pattern color of the style.
System.Drawing.Color	getRightColor_Border() Returns the color of the right border.
int	getRightStyle_Border() Returns the style of the right border.
int	getTextRotation() Returns the text rotation of the style.
System.Drawing.Color	getTopColor_Border() Returns the color of the top border.
int	getTopStyle_Border() Returns the style of the top border.
int	getUnderlineStyle() Returns the underline style of the style font.
System.String	getVerticalAlignment() Returns the vertical alignment of the style.
bool	IsBold() Returns the bold setting of the style font.
bool	IsEqual(ExcelStyle xlsCompare) Compares two styles.
bool	IsHiddenFormula() Returns the hidden setting of the style.
bool	IsItalic() Returns the italic setting of the style font.
bool	IsLocked() Returns the locked setting of the style.
bool	IsMergeCell() Returns the merge cell option of the style
bool	IsShrink() Returns the shrink setting of the style.
bool	IsStrikethrough() Returns the strikethrough setting of the style font.
bool	IsSubscript() Returns the subscript setting of the style font.
bool	IsSuperscript() Returns the superscript setting of the style font.
bool	IsWrap() Returns the wrap setting of the style.
void	setBackground(System.Drawing.Color color) Sets the background color of the style.
void	setBold(bool isBold) Sets the bold option of the style font.
void	setBorderColors(System.Drawing.Color borderTop, System.Drawing.Color borderBottom, System.Drawing.Color borderLeft, System.Drawing.Color borderRight) Sets the border colors of the style.
void	setBorderStyles(int borderTop, int borderBottom, int borderLeft, int borderRight) Sets the border styles of the style.
void	setBottomColor_Border(System.Drawing.Color color) Sets the color of the bottom border.
void	setBottomStyle_Border(int borderStyle) Sets the style of the bottom border.
void	setDataType(System.String dataType) Sets the data type of the style.
void	setFont(System.String fontName) Sets the name of the style font.
void	setFontSize(int fontSize) Sets the size of the style font.
void	setForeground(System.Drawing.Color color) Sets the foreground color of the style.
void	setFormat(System.String format) Sets the number/date format of the style.
void	setHiddenFormula(bool isHidden) Sets the hidden option of the style.
void	setHorizontalAlignment(System.String horizontalAlignment) Sets the horizontal alignment of the style.
void	setIndent(int indent) Sets the the indent of the style.
void	setItalic(bool isItalic) Sets the italic option of the style font.
void	setLeftColor_Border(System.Drawing.Color color) Sets the color of the left border.
void	setLeftStyle_Border(int borderStyle) Sets the style of the left border.
void	setLocked(bool isLocked) Sets the locked option of the style.
void	setPattern(int pattern) Sets the pattern of the style.
void	setPatternColor(System.Drawing.Color color) Sets the pattern color of the style.
void	setRightColor_Border(System.Drawing.Color color) Sets the color of the right border.
void	setRightStyle_Border(int borderStyle) Sets the style of the right border.
void	setShrink(bool isShrink) Sets the shrink option of the style.
void	setStrikethrough(bool isStrikethrough) Sets the strikethrough option of the style font.
void	setSubscript(bool isSubscript) Sets the subscript option of the style font.
void	setSuperscript(bool isSuperscript) Sets the superscript option of the style font.
void	setTextRotation(int textRotation) Sets the text rotation of the style.
void	setTopColor_Border(System.Drawing.Color color) Sets the color of the top border.
void	setTopStyle_Border(int borderStyle) Sets the style of the top border.
void	setUnderlineStyle(int underlineStyle) Sets the underline style of the style font.
void	setVerticalAlignment(System.String verticalAlignment) Sets the vertical alignment of the style.
void	setWrap(bool isWrap) Sets the wrap option of the style.

Constructor Detail

ExcelStyle

public ExcelStyle()

Defines an instance of the style.

ExcelStyle

public ExcelStyle(System.Drawing.Color background)

Defines an instance of the style that is initialized with background color.

Parameters:

background - the background color of the style

ExcelStyle

public ExcelStyle(System.String fontName,
                  int fontSize,
                  bool isBold,
                  bool isItalic,
                  System.Drawing.Color foreground)

Defines an instance of the style that is initialized with font settings.

Parameters:

fontName - the name of the style font

fontSize - the size of the style font

isBold - the bold option of the style font

isItalic - the italic option of the style font

foreground - the foreground color of the style

ExcelStyle

public ExcelStyle(System.String fontName,
                  int fontSize,
                  bool isBold,
                  bool isItalic,
                  System.Drawing.Color foreground,
                  System.Drawing.Color background)

Defines an instance of the style that is initialized with font and background settings.

Parameters:

fontName - the name of the style font

fontSize - the size of the style font

isBold - the bold option of the style font

isItalic - the italic option of the style font

foreground - the foreground color of the style

background - the background color of the style

Method Detail

getUnderlineStyle

public int getUnderlineStyle()

Returns the underline style of the style font. Possible values are available in FontSettings class.

Returns:

the underline style of the style font

See Also:

setUnderlineStyle(int)

setUnderlineStyle

public void setUnderlineStyle(int underlineStyle)

Sets the underline style of the style font. Possible values are available in FontSettings class.

Parameters:

underlineStyle - underline style of the style font

See Also:

getUnderlineStyle()

getFontSize

public int getFontSize()

Returns the size of the style font.

Returns:

the size of the style font

See Also:

setFontSize(int)

setFontSize

public void setFontSize(int fontSize)

Sets the size of the style font.

Parameters:

fontSize - the size of the style font

See Also:

getFontSize()

getFont

public System.String getFont()

Returns the name of the style font.

Returns:

the name of the style font

See Also:

setFont(System.String)

setFont

public void setFont(System.String fontName)

Sets the name of the style font.

Parameters:

fontName - the name of the style font

See Also:

getFont()

IsStrikethrough

public bool IsStrikethrough()

Returns the strikethrough setting of the style font.

Returns:

the strikethrough setting of the style font

See Also:

setStrikethrough(bool)

setStrikethrough

public void setStrikethrough(bool isStrikethrough)

Sets the strikethrough option of the style font.

Parameters:

isStrikethrough - the strikethrough option of the style font

See Also:

IsStrikethrough()

IsSuperscript

public bool IsSuperscript()

Returns the superscript setting of the style font.

Returns:

the superscript setting of the style font

See Also:

setSuperscript(bool)

setSuperscript

public void setSuperscript(bool isSuperscript)

Sets the superscript option of the style font.

Parameters:

isSuperscript - the superscript option of the style font

See Also:

IsSuperscript()

IsSubscript

public bool IsSubscript()

Returns the subscript setting of the style font.

Returns:

the subscript setting of the style font

See Also:

setSubscript(bool)

setSubscript

public void setSubscript(bool isSubscript)

Sets the subscript option of the style font.

Parameters:

isSubscript - the subscript option of the style font

See Also:

IsSubscript()

IsWrap

public bool IsWrap()

Returns the wrap setting of the style.

Returns:

the wrap setting of the style

See Also:

setWrap(bool)

setWrap

public void setWrap(bool isWrap)

Sets the wrap option of the style.

Parameters:

isWrap - the wrap option of the style

See Also:

IsWrap()

getBackground

public System.Drawing.Color getBackground()

Returns the background color of the style.

Returns:

the background color of the style

See Also:

setBackground(System.Drawing.Color)

setBackground

public void setBackground(System.Drawing.Color color)

Sets the background color of the style.

Parameters:

color - the background color of the style

See Also:

getBackground()

getForeground

public System.Drawing.Color getForeground()

Returns the foreground color of the style.

Returns:

the foreground color of the style

See Also:

setForeground(System.Drawing.Color)

setForeground

public void setForeground(System.Drawing.Color color)

Sets the foreground color of the style.

Parameters:

color - the foreground color of the style

See Also:

getForeground()

IsBold

public bool IsBold()

Returns the bold setting of the style font.

Returns:

the bold setting of the style font

See Also:

setBold(bool)

setBold

public void setBold(bool isBold)

Sets the bold option of the style font.

Parameters:

isBold - the bold option of the style font

See Also:

IsBold()

IsItalic

public bool IsItalic()

Returns the italic setting of the style font.

Returns:

the italic setting of the style font

See Also:

setItalic(bool)

setItalic

public void setItalic(bool isItalic)

Sets the italic option of the style font.

Parameters:

isItalic - the italic option of the style font

See Also:

IsItalic()

getHorizontalAlignment

public System.String getHorizontalAlignment()

Returns the horizontal alignment of the style. Possible values are available in Alignment class.

Returns:

the horizontal alignment of the style

See Also:

setHorizontalAlignment(System.String)

setHorizontalAlignment

public void setHorizontalAlignment(System.String horizontalAlignment)

Sets the horizontal alignment of the style. Possible values are available in Alignment class.

Parameters:

horizontalAlignment - the horizontal alignment of the style

See Also:

getHorizontalAlignment()

getVerticalAlignment

public System.String getVerticalAlignment()

Returns the vertical alignment of the style. Possible values are available in Alignment class.

Returns:

the vertical alignment of the style

See Also:

setVerticalAlignment(System.String)

setVerticalAlignment

public void setVerticalAlignment(System.String verticalAlignment)

Sets the vertical alignment of the style. Possible values are available in Alignment class.

Parameters:

verticalAlignment - the vertical alignment of the style

See Also:

getVerticalAlignment()

getTextRotation

public int getTextRotation()

Returns the text rotation of the style.

Returns:

the text rotation of the style.

See Also:

setTextRotation(int)

setTextRotation

public void setTextRotation(int textRotation)

Sets the text rotation of the style.

Parameters:

textRotation - the text rotation of the style.

See Also:

getTextRotation()

getIndent

public int getIndent()

Returns the indent of the style.

Returns:

the indent of the style.

See Also:

setIndent(int)

setIndent

public void setIndent(int indent)

Sets the the indent of the style.

Parameters:

indent - the indent of the style.

See Also:

getIndent()

getPattern

public int getPattern()

Returns the pattern of the style.

Returns:

the pattern of the style

See Also:

setPattern(int)

setPattern

public void setPattern(int pattern)

Sets the pattern of the style.

Parameters:

pattern - the pattern of the style

See Also:

getPattern()

getPatternColor

public System.Drawing.Color getPatternColor()

Returns the pattern color of the style.

Returns:

the pattern color of the style

See Also:

setPatternColor(System.Drawing.Color)

setPatternColor

public void setPatternColor(System.Drawing.Color color)

Sets the pattern color of the style.

Parameters:

color - the pattern color of the style

See Also:

getPatternColor()

getFormat

public System.String getFormat()

Returns the number/date format of the style. Possible values are available in Format class.

Returns:

the number/date format of the style

See Also:

setFormat(System.String)

setFormat

public void setFormat(System.String format)

Sets the number/date format of the style. Possible values are available in Format class.

Parameters:

format - the number/date format of the style

See Also:

getFormat()

IsLocked

public bool IsLocked()

Returns the locked setting of the style.

Returns:

the locked setting of the style

See Also:

setLocked(bool)

setLocked

public void setLocked(bool isLocked)

Sets the locked option of the style.

Parameters:

isLocked - the locked option of the style

See Also:

IsLocked()

IsShrink

public bool IsShrink()

Returns the shrink setting of the style.

Returns:

the shrink setting of the style

See Also:

setShrink(bool)

setShrink

public void setShrink(bool isShrink)

Sets the shrink option of the style.

Parameters:

isShrink - the shrink option of the style

See Also:

IsShrink()

IsMergeCell

public bool IsMergeCell()

Returns the merge cell option of the style

Returns:

the merge cell option of the style

IsHiddenFormula

public bool IsHiddenFormula()

Returns the hidden setting of the style.

Returns:

the hidden setting of the style

See Also:

setHiddenFormula(bool)

setHiddenFormula

public void setHiddenFormula(bool isHidden)

Sets the hidden option of the style.

Parameters:

isHidden - the hidden option of the style

See Also:

IsHiddenFormula()

getDataType

public System.String getDataType()

Returns the data type of the style. The default value is DataType.AUTOMATIC. Automatic data type can be resource and time consuming and we recommend using a defined one. Possible values are available in DataType class.

Returns:

the data type of the cell

See Also:

setDataType(System.String)

setDataType

public void setDataType(System.String dataType)

Sets the data type of the style. The default value is DataType.AUTOMATIC. Automatic data type can be resource and time consuming and we recommend using a defined one. Possible values are available in DataType class.

Parameters:

dataType - the data type of the cell

See Also:

getDataType()

setBorderStyles

public void setBorderStyles(int borderTop,
                            int borderBottom,
                            int borderLeft,
                            int borderRight)

Sets the border styles of the style. Possible values are available in Border class.

Parameters:

borderTop - the border style in the top of cell

borderBottom - the border style in the bottom of cell

borderLeft - the border style in the left of cell

borderRight - the border style in the right of cell

See Also:

getTopStyle_Border(), getBottomStyle_Border(), getLeftStyle_Border(), getRightStyle_Border(), setBorderColors(System.Drawing.Color, System.Drawing.Color, System.Drawing.Color, System.Drawing.Color)

getTopStyle_Border

public int getTopStyle_Border()

Returns the style of the top border. Possible values are available in Border class.

Returns:

the style of the top border

See Also:

setTopStyle_Border(int)

setTopStyle_Border

public void setTopStyle_Border(int borderStyle)

Sets the style of the top border. Possible values are available in Border class.

Parameters:

borderStyle - the style of the top border

See Also:

getTopStyle_Border()

getBottomStyle_Border

public int getBottomStyle_Border()

Returns the style of the bottom border. Possible values are available in Border class.

Returns:

the style of the bottom border

See Also:

setBottomStyle_Border(int)

setBottomStyle_Border

public void setBottomStyle_Border(int borderStyle)

Sets the style of the bottom border. Possible values are available in Border class.

Parameters:

borderStyle - the style of the bottom border

See Also:

getBottomStyle_Border()

getLeftStyle_Border

public int getLeftStyle_Border()

Returns the style of the left border. Possible values are available in Border class.

Returns:

the style of the left border

See Also:

setLeftStyle_Border(int)

setLeftStyle_Border

public void setLeftStyle_Border(int borderStyle)

Sets the style of the left border. Possible values are available in Border class.

Parameters:

borderStyle - the style of the left border

See Also:

getLeftStyle_Border()

getRightStyle_Border

public int getRightStyle_Border()

Returns the style of the right border. Possible values are available in Border class.

Returns:

the style of the right border

See Also:

setRightStyle_Border(int)

setRightStyle_Border

public void setRightStyle_Border(int borderStyle)

Sets the style of the right border. Possible values are available in Border class.

Parameters:

borderStyle - the style of the right border

See Also:

getRightStyle_Border()

setBorderColors

public void setBorderColors(System.Drawing.Color borderTop,
                            System.Drawing.Color borderBottom,
                            System.Drawing.Color borderLeft,
                            System.Drawing.Color borderRight)

Sets the border colors of the style.

Parameters:

borderTop - the border color in the top of cell

borderBottom - the border color in the bottom of cell

borderLeft - the border color in the left of cell

borderRight - the border color in the right of cell

See Also:

getTopColor_Border(), getBottomColor_Border(), getLeftColor_Border(), getRightColor_Border(), setBorderStyles(int, int, int, int)

getTopColor_Border

public System.Drawing.Color getTopColor_Border()

Returns the color of the top border.

Returns:

the color of the top border

See Also:

setTopColor_Border(System.Drawing.Color)

setTopColor_Border

public void setTopColor_Border(System.Drawing.Color color)

Sets the color of the top border.

Parameters:

color - the color of the top border

See Also:

getTopColor_Border()

getBottomColor_Border

public System.Drawing.Color getBottomColor_Border()

Returns the color of the bottom border.

Returns:

the color of the bottom border

See Also:

setBottomColor_Border(System.Drawing.Color)

setBottomColor_Border

public void setBottomColor_Border(System.Drawing.Color color)

Sets the color of the bottom border.

Parameters:

color - the color of the bottom border

See Also:

getBottomColor_Border()

getLeftColor_Border

public System.Drawing.Color getLeftColor_Border()

Returns the color of the left border.

Returns:

the color of the left border

See Also:

setLeftColor_Border(System.Drawing.Color)

setLeftColor_Border

public void setLeftColor_Border(System.Drawing.Color color)

Sets the color of the left border.

Parameters:

color - the color of the left border

See Also:

getLeftColor_Border()

getRightColor_Border

public System.Drawing.Color getRightColor_Border()

Returns the color of the right border.

Returns:

the color of the right border

See Also:

setRightColor_Border(System.Drawing.Color)

setRightColor_Border

public void setRightColor_Border(System.Drawing.Color color)

Sets the color of the right border.

Parameters:

color - the color of the right border

See Also:

getRightColor_Border()

Clone

public ExcelStyle Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.

IsEqual

public bool IsEqual(ExcelStyle xlsCompare)

Compares two styles.

Parameters:

xlsCompare - the style that will be compared to

Returns:

true if the styles have the same settings