Namespace EasyXLS

Class ExcelColumn

System.Object

EasyXLS.ExcelColumn

public class ExcelColumn
extends System.Object

This class stores the column information extends width and format (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, column cells locked or hidden, shrink, border type, border color).

Constructor Summary

Constructors

Constructor	Description
ExcelColumn()	Defines an instance of the Excel column.

Method Summary

Modifier and Type	Method	Description
ExcelColumn	Clone()	Creates and returns a copy of this object.
int	Count()	Returns the number of cells contained by the column.
System.Drawing.Color	getBackground()	Returns the background color of the column.
ThemeColor	getBackgroundThemeColor()	Returns the background color of the column.
System.Drawing.Color	getBottomColor_Border()	Returns the color of the bottom border.
int	getBottomStyle_Border()	Returns the style of the bottom border.
ThemeColor	getBottomThemeColor_Border()	Returns the color of the bottom border.
System.String	getDataType()	Returns the data type of the column.
System.Drawing.Color	getDiagonalColor_Border()	Returns the color of the diagonal border.
int	getDiagonalDownStyle_Border()	Returns the style of the diagonal down border.
ThemeColor	getDiagonalThemeColor_Border()	Returns the color of the diagonal border.
int	getDiagonalUpStyle_Border()	Returns the style of the diagonal up border.
System.String	getFont()	Returns the name of the column font.
int	getFontSize()	Returns the size of the column font.
System.Drawing.Color	getForeground()	Returns the foreground color of the column.
ThemeColor	getForegroundThemeColor()	Returns the foreground color of the column.
System.String	getFormat()	Returns the number/date format of the column.
System.Drawing.Color	getGradientColor1()	Returns the first color of the gradient fill.
System.Drawing.Color	getGradientColor2()	Returns the second color of the gradient fill.
int	getGradientShadingStyle()	Returns the shading style of the gradient fill.
ThemeColor	getGradientThemeColor1()	Returns the first color of the gradient fill.
ThemeColor	getGradientThemeColor2()	Returns the second color of the gradient fill.
System.String	getHorizontalAlignment()	Returns the horizontal alignment of the column.
int	getIndent()	Returns the indent of the column.
System.Drawing.Color	getLeftColor_Border()	Returns the color of the left border.
int	getLeftStyle_Border()	Returns the style of the left border.
ThemeColor	getLeftThemeColor_Border()	Returns the color of the left border.
int	getOutlineLevel()	Internal use only
int	getPattern()	Returns the pattern of the column.
System.Drawing.Color	getPatternColor()	Returns the pattern color of the column.
ThemeColor	getPatternThemeColor()	Returns the pattern color of the column.
System.Drawing.Color	getRightColor_Border()	Returns the color of the right border.
int	getRightStyle_Border()	Returns the style of the right border.
ThemeColor	getRightThemeColor_Border()	Returns the color of the right border.
ExcelStyle	getStyle()	Returns the style of the column.
int	getTextDirection()	Returns the text direction of the column.
int	getTextRotation()	Returns the text rotation of the column.
System.Drawing.Color	getTopColor_Border()	Returns the color of the top border.
int	getTopStyle_Border()	Returns the style of the top border.
ThemeColor	getTopThemeColor_Border()	Returns the color of the top border.
int	getUnderlineStyle()	Returns the underline style of the column font.
System.String	getVerticalAlignment()	Returns the vertical alignment of the column.
int	getWidth()	Returns the width of the column.
int	getXF()	Internal use only
bool	IsBodyFont()	Returns true if the font is the body font, false otherwise.
bool	IsBold()	Returns the bold setting of the column font.
bool	IsCollapsed()	Internal use only
bool	IsHeadingsFont()	Returns true if the font is the headings font, false otherwise.
bool	IsHiddenColumn()	Returns the hidden option of the column.
bool	IsHiddenFormula()	Returns the hidden setting of the column.
bool	IsItalic()	Returns the italic setting of the column font.
bool	IsJustifyDistributed()	Returns the justify distributed setting of the column.
bool	IsLocked()	Returns the locked setting of the column.
bool	IsShrink()	Returns the shrink setting of the column.
bool	IsStrikethrough()	Returns the strikethrough setting of the column font.
bool	IsSubscript()	Returns the subscript setting of the column font.
bool	IsSuperscript()	Returns the superscript setting of the column font.
bool	IsWrap()	Returns the wrap setting of the column.
void	setBackground(ThemeColor themeColor)	Sets the background color of the column. This method is overridden as setBackground_2 in COM+ version of EasyXLS.
void	setBackground(System.Drawing.Color color)	Sets the background color of the column.
void	setBodyFont()	Sets the body font.
void	setBold(bool isBold)	Sets the bold option of the column font.
void	setBorderColors(ThemeColor borderTop, ThemeColor borderBottom, ThemeColor borderLeft, ThemeColor borderRight)	Sets the border colors of the style. This method is overridden as setBorderColors_2 in COM+ version of EasyXLS.
void	setBorderColors(System.Drawing.Color borderTop, System.Drawing.Color borderBottom, System.Drawing.Color borderLeft, System.Drawing.Color borderRight)	Sets the border colors of the column.
void	setBorderStyles(int borderTop, int borderBottom, int borderLeft, int borderRight)	Sets the border styles of the column.
void	setBottomColor_Border(ThemeColor themeColor)	Sets the color of the bottom border. This method is overridden as setBottomColor_Border_2 in COM+ version of EasyXLS.
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	setCollapsed(bool isCollapsed)	Internal use only
void	setDataType(System.String dataType)	Sets the data type of the column.
void	setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, ThemeColor borderColor)	Sets the diagonal borders. This method is overridden as setDiagonalBorder_2 in COM+ version of EasyXLS.
void	setDiagonalBorder(bool borderDiagonalUp, bool borderDiagonalDown, int borderStyle, System.Drawing.Color borderColor)	Sets the diagonal borders.
void	setFont(System.String fontName)	Sets the name of the column font.
void	setFontSize(int fontSize)	Sets the size of the column font.
void	setForeground(ThemeColor themeColor)	Sets the foreground color of the column. This method is overridden as setForeground_2 in COM+ version of EasyXLS.
void	setForeground(System.Drawing.Color color)	Sets the foreground color of the column.
void	setFormat(System.String format)	Sets the number/date format of the column.
void	setGradientFill(ThemeColor themeColor1, ThemeColor themeColor2, int shadingStyle)	Sets the gradient fill for the style.
void	setGradientFill(System.Drawing.Color color1, System.Drawing.Color color2, int shadingStyle)	Sets the gradient fill for the style.
void	setHeadingsFont()	Sets the headings font.
void	setHiddenColumn(bool isHidden)	Sets the hidden option of the column.
void	setHiddenFormula(bool isHidden)	Sets the hidden option of the column.
void	setHorizontalAlignment(System.String horizontalAlignment)	Sets the horizontal alignment of the column.
void	setIndent(int indent)	Sets the indent of the column.
void	setItalic(bool isItalic)	Sets the italic option of the column font.
void	setJustifyDistributed(bool isJustifyDistributed)	Sets the justify distributed option of the column.
void	setLeftColor_Border(ThemeColor themeColor)	Sets the color of the left border. This method is overridden as setLeftColor_Border_2 in COM+ version of EasyXLS.
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 column.
void	setOutlineLevel(int nOutlineLevel)	Internal use only
void	setPattern(int pattern)	Sets the pattern of the column.
void	setPatternColor(ThemeColor themeColor)	Sets the pattern color of the column. This method is overridden as setPatternColor_2 in COM+ version of EasyXLS.
void	setPatternColor(System.Drawing.Color color)	Sets the pattern color of the column.
void	setRightColor_Border(ThemeColor themeColor)	Sets the color of the right border. This method is overridden as setRightColor_Border_2 in COM+ version of EasyXLS.
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 column.
void	setStrikethrough(bool isStrikethrough)	Sets the strikethrough option of the column font.
void	setStyle(ExcelStyle xlsStyle)	Sets the style of the column.
void	setSubscript(bool isSubscript)	Sets the subscript option of the column font.
void	setSuperscript(bool isSuperscript)	Sets the superscript option of the column font.
void	setTextDirection(int textDirection)	Sets the text direction of the column.
void	setTextRotation(int textRotation)	Sets the text rotation of the column.
void	setTopColor_Border(ThemeColor themeColor)	Sets the color of the top border. This method is overridden as setTopColor_Border_2 in COM+ version of EasyXLS.
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 column font.
void	setVerticalAlignment(System.String verticalAlignment)	Sets the vertical alignment of the column.
void	setWidth(int width)	Sets the width of the column.
void	setWrap(bool isWrap)	Sets the wrap option of the column.
void	setXF(int xfIndex)	Internal use only

Methods inherited from class System.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Details

ExcelColumn

public ExcelColumn()

Defines an instance of the Excel column.

Method Details

Count

public int Count()

Returns the number of cells contained by the column. Not implemented yet.

Returns:

the number of cells contained by the column

getWidth

public int getWidth()

Returns the width of the column.

Returns:

the width of the column

See Also:

• setWidth(int)

setWidth

public void setWidth(int width)

Sets the width of the column.

Parameters:

width - the width of the column

See Also:

• getWidth()

IsHiddenColumn

public bool IsHiddenColumn()

Returns the hidden option of the column.

Returns:

the hidden option of the column.

See Also:

• setHiddenColumn(bool)

setHiddenColumn

public void setHiddenColumn(bool isHidden)

Sets the hidden option of the column.

Parameters:

isHidden - the hidden option of the column

See Also:

• IsHiddenColumn()

getDataType

public System.String getDataType()

Returns the data type of the column. 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 column

See Also:

• setDataType(System.String)

setDataType

public void setDataType(System.String dataType)

Sets the data type of the column. 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 column

See Also:

• getDataType()

getStyle

public ExcelStyle getStyle()

Returns the style of the column.

Returns:

the style of the column

See Also:

• setStyle(EasyXLS.ExcelStyle)

setStyle

public void setStyle(ExcelStyle xlsStyle)

Sets the style of the column.

Parameters:

xlsStyle - the style of the column

See Also:

• getStyle()

getXF

public int getXF()

Internal use only

Returns:

the xf index of the style

setXF

public void setXF(int xfIndex)

Internal use only

Parameters:

xfIndex - the xf index of the style

getFormat

public System.String getFormat()

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

Returns:

the number/date format of the column

See Also:

• setFormat(System.String)

setFormat

public void setFormat(System.String format)

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

Parameters:

format - the number/date format of the column

See Also:

• getFormat()

getHorizontalAlignment

public System.String getHorizontalAlignment()

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

Returns:

the horizontal alignment of the column

See Also:

• setHorizontalAlignment(System.String)

setHorizontalAlignment

public void setHorizontalAlignment(System.String horizontalAlignment)

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

Parameters:

horizontalAlignment - the horizontal alignment of the column

See Also:

• getHorizontalAlignment()

getVerticalAlignment

public System.String getVerticalAlignment()

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

Returns:

the vertical alignment of the column

See Also:

• setVerticalAlignment(System.String)

setVerticalAlignment

public void setVerticalAlignment(System.String verticalAlignment)

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

Parameters:

verticalAlignment - the vertical alignment of the column

See Also:

• getVerticalAlignment()

IsJustifyDistributed

public bool IsJustifyDistributed()

Returns the justify distributed setting of the column. It can only be used for distributed alignment.

Returns:

the justify distributed setting of the column

See Also:

• setJustifyDistributed(bool)

setJustifyDistributed

public void setJustifyDistributed(bool isJustifyDistributed)

Sets the justify distributed option of the column. It can only be used for distributed alignment.

Parameters:

isJustifyDistributed - the justify distributed option of the column

See Also:

• IsJustifyDistributed()

getIndent

public int getIndent()

Returns the indent of the column.

Returns:

the indent of the column.

See Also:

• setIndent(int)

setIndent

public void setIndent(int indent)

Sets the indent of the column.

Parameters:

indent - the indent of the column.

See Also:

• getIndent()

getTextRotation

public int getTextRotation()

Returns the text rotation of the column.

Returns:

the text rotation of the column

See Also:

• setTextRotation(int)

setTextRotation

public void setTextRotation(int textRotation)

Sets the text rotation of the column.

Parameters:

textRotation - the text rotation of the column

See Also:

• getTextRotation()

IsWrap

public bool IsWrap()

Returns the wrap setting of the column.

Returns:

the wrap setting of the column

See Also:

• setWrap(bool)

setWrap

public void setWrap(bool isWrap)

Sets the wrap option of the column.

Parameters:

isWrap - the wrap option of the column

See Also:

• IsWrap()

IsShrink

public bool IsShrink()

Returns the shrink setting of the column.

Returns:

the shrink setting of the column

See Also:

• setShrink(bool)

setShrink

public void setShrink(bool isShrink)

Sets the shrink option of the column.

Parameters:

isShrink - the shrink option of the column

See Also:

• IsShrink()

getTextDirection

public int getTextDirection()

Returns the text direction of the column.

Returns:

the text direction of the column

See Also:

• setTextDirection(int)

setTextDirection

public void setTextDirection(int textDirection)

Sets the text direction of the column.

Parameters:

textDirection - the text direction of the column

See Also:

• getTextDirection()

getFont

public System.String getFont()

Returns the name of the column font.

Returns:

the name of the column font

See Also:

• setFont(System.String)

setFont

public void setFont(System.String fontName)

Sets the name of the column font.

Parameters:

fontName - the name of the column font

See Also:

• getFont()

IsHeadingsFont

public bool IsHeadingsFont()

Returns true if the font is the headings font, false otherwise.

Returns:

true if the font is the headings font, false otherwise

See Also:

• setHeadingsFont()
• setFont(System.String)

setHeadingsFont

public void setHeadingsFont()

Sets the headings font.

See Also:

• IsHeadingsFont()
• setFont(System.String)

IsBodyFont

public bool IsBodyFont()

Returns true if the font is the body font, false otherwise.

Returns:

true if the font is the body font, false otherwise

See Also:

• setBodyFont()
• setFont(System.String)

setBodyFont

public void setBodyFont()

Sets the body font.

See Also:

• IsBodyFont()
• setFont(System.String)

getFontSize

public int getFontSize()

Returns the size of the column font.

Returns:

the size of the column font

See Also:

• setFontSize(int)

setFontSize

public void setFontSize(int fontSize)

Sets the size of the column font.

Parameters:

fontSize - the size of the column font

See Also:

• getFontSize()

IsBold

public bool IsBold()

Returns the bold setting of the column font.

Returns:

the bold setting of the column font

See Also:

• setBold(bool)

setBold

public void setBold(bool isBold)

Sets the bold option of the column font.

Parameters:

isBold - the bold option of the column font

See Also:

• IsBold()

IsItalic

public bool IsItalic()

Returns the italic setting of the column font.

Returns:

the italic setting of the column font

See Also:

• setItalic(bool)

setItalic

public void setItalic(bool isItalic)

Sets the italic option of the column font.

Parameters:

isItalic - the italic option of the column font

See Also:

• IsItalic()

getUnderlineStyle

public int getUnderlineStyle()

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

Returns:

the underline style of the column font

See Also:

• setUnderlineStyle(int)

setUnderlineStyle

public void setUnderlineStyle(int UnderlineStyle)

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

Parameters:

UnderlineStyle - underline style of the column font

See Also:

• getUnderlineStyle()

getForeground

public System.Drawing.Color getForeground()

Returns the foreground color of the column.

Returns:

the foreground color of the column

See Also:

• setForeground(Color)

getForegroundThemeColor

public ThemeColor getForegroundThemeColor()

Returns the foreground color of the column.

Returns:

the foreground color of the column

See Also:

• setForeground(ThemeColor)

setForeground

public void setForeground(System.Drawing.Color color)

Sets the foreground color of the column.

Parameters:

color - the foreground color of the column

See Also:

• getForeground()

setForeground

public void setForeground(ThemeColor themeColor)

Sets the foreground color of the column.
This method is overridden as setForeground_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the foreground color of the column

See Also:

• getForegroundThemeColor()

IsStrikethrough

public bool IsStrikethrough()

Returns the strikethrough setting of the column font.

Returns:

the strikethrough setting of the column font

See Also:

• setStrikethrough(bool)

setStrikethrough

public void setStrikethrough(bool isStrikethrough)

Sets the strikethrough option of the column font.

Parameters:

isStrikethrough - the strikethrough option of the column font

See Also:

• IsStrikethrough()

IsSuperscript

public bool IsSuperscript()

Returns the superscript setting of the column font.

Returns:

the superscript setting of the column font

See Also:

• setSuperscript(bool)

setSuperscript

public void setSuperscript(bool isSuperscript)

Sets the superscript option of the column font.

Parameters:

isSuperscript - the superscript option of the column font

See Also:

• IsSuperscript()

IsSubscript

public bool IsSubscript()

Returns the subscript setting of the column font.

Returns:

the subscript setting of the column font

See Also:

• setSubscript(bool)

setSubscript

public void setSubscript(bool isSubscript)

Sets the subscript option of the column font.

Parameters:

isSubscript - the subscript option of the column font

See Also:

• IsSubscript()

setBorderStyles

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

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

Parameters:

borderTop - the border style for the top side of the cell

borderBottom - the border style for the bottom side of the cell

borderLeft - the border style for the left side of the cell

borderRight - the border style for the right side of the 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 column.

Parameters:

borderTop - the border color for the top side of the cell

borderBottom - the border color for the bottom side of the cell

borderLeft - the border color for the left side of the cell

borderRight - the border color for the right side of the cell.

See Also:

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

setBorderColors

public void setBorderColors(ThemeColor borderTop,
 ThemeColor borderBottom,
 ThemeColor borderLeft,
 ThemeColor borderRight)

Sets the border colors of the style.
This method is overridden as setBorderColors_2 in COM+ version of EasyXLS.

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:

• getTopThemeColor_Border()
• getBottomThemeColor_Border()
• getLeftThemeColor_Border()
• getRightThemeColor_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)

getTopThemeColor_Border

public ThemeColor getTopThemeColor_Border()

Returns the color of the top border.

Returns:

the color of the top border

See Also:

• setTopColor_Border(ThemeColor)

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()

setTopColor_Border

public void setTopColor_Border(ThemeColor themeColor)

Sets the color of the top border.
This method is overridden as setTopColor_Border_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the color of the top border

See Also:

• getTopThemeColor_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)

getBottomThemeColor_Border

public ThemeColor getBottomThemeColor_Border()

Returns the color of the bottom border.

Returns:

the color of the bottom border

See Also:

• setBottomColor_Border(ThemeColor)

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()

setBottomColor_Border

public void setBottomColor_Border(ThemeColor themeColor)

Sets the color of the bottom border.
This method is overridden as setBottomColor_Border_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the color of the bottom border

See Also:

• getBottomThemeColor_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)

getLeftThemeColor_Border

public ThemeColor getLeftThemeColor_Border()

Returns the color of the left border.

Returns:

the color of the left border

See Also:

• setLeftColor_Border(ThemeColor)

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()

setLeftColor_Border

public void setLeftColor_Border(ThemeColor themeColor)

Sets the color of the left border.
This method is overridden as setLeftColor_Border_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the color of the left border

See Also:

• getLeftThemeColor_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)

getRightThemeColor_Border

public ThemeColor getRightThemeColor_Border()

Returns the color of the right border.

Returns:

the color of the right border

See Also:

• setRightColor_Border(ThemeColor)

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()

setRightColor_Border

public void setRightColor_Border(ThemeColor themeColor)

Sets the color of the right border.
This method is overridden as setRightColor_Border_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the color of the right border

See Also:

• getRightThemeColor_Border()

setDiagonalBorder

public void setDiagonalBorder(bool borderDiagonalUp,
 bool borderDiagonalDown,
 int borderStyle,
 System.Drawing.Color borderColor)

Sets the diagonal borders.

Parameters:

borderDiagonalUp - true if the diagonal up border is set

borderDiagonalDown - true if the diagonal down border is set

borderStyle - the style of the diagonal border. Possible values are available in Border class.

borderColor - the color of the diagonal border

See Also:

• getDiagonalUpStyle_Border()
• getDiagonalDownStyle_Border()
• getDiagonalColor_Border()
• setDiagonalBorder(bool,bool,int,ThemeColor)

setDiagonalBorder

public void setDiagonalBorder(bool borderDiagonalUp,
 bool borderDiagonalDown,
 int borderStyle,
 ThemeColor borderColor)

Sets the diagonal borders.
This method is overridden as setDiagonalBorder_2 in COM+ version of EasyXLS.

Parameters:

borderDiagonalUp - true if the diagonal up border is set

borderDiagonalDown - true if the diagonal down border is set

borderStyle - the style of the diagonal border. Possible values are available in Border class.

borderColor - the color of the diagonal border

See Also:

• getDiagonalUpStyle_Border()
• getDiagonalDownStyle_Border()
• getDiagonalColor_Border()
• setDiagonalBorder(bool,bool,int,Color)

getDiagonalUpStyle_Border

public int getDiagonalUpStyle_Border()

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

Returns:

the style of the diagonal up border

See Also:

• setDiagonalBorder(bool,bool,int,Color)
• setDiagonalBorder(bool,bool,int,ThemeColor)

getDiagonalDownStyle_Border

public int getDiagonalDownStyle_Border()

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

Returns:

the style of the diagonal down border

See Also:

• setDiagonalBorder(bool,bool,int,Color)
• setDiagonalBorder(bool,bool,int,ThemeColor)

getDiagonalColor_Border

public System.Drawing.Color getDiagonalColor_Border()

Returns the color of the diagonal border.

Returns:

the color of the diagonal border

See Also:

• setDiagonalBorder(bool,bool,int,Color)

getDiagonalThemeColor_Border

public ThemeColor getDiagonalThemeColor_Border()

Returns the color of the diagonal border.

Returns:

the color of the diagonal border

See Also:

• setDiagonalBorder(bool,bool,int,ThemeColor)

getBackground

public System.Drawing.Color getBackground()

Returns the background color of the column.

Returns:

the background color of the column

See Also:

• setBackground(System.Drawing.Color)

getBackgroundThemeColor

public ThemeColor getBackgroundThemeColor()

Returns the background color of the column.

Returns:

the background color of the column

See Also:

• setBackground(ThemeColor)

setBackground

public void setBackground(System.Drawing.Color color)

Sets the background color of the column.

Parameters:

color - the background color of the column

See Also:

• getBackground()

setBackground

public void setBackground(ThemeColor themeColor)

Sets the background color of the column.
This method is overridden as setBackground_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the background color of the column

See Also:

• getBackgroundThemeColor()

getPattern

public int getPattern()

Returns the pattern of the column.

Returns:

the pattern of the column

See Also:

• setPattern(int)

setPattern

public void setPattern(int pattern)

Sets the pattern of the column.

Parameters:

pattern - the pattern of the column

See Also:

• getPattern()

getPatternColor

public System.Drawing.Color getPatternColor()

Returns the pattern color of the column.

Returns:

the pattern color of the column

See Also:

• setPatternColor(System.Drawing.Color)

getPatternThemeColor

public ThemeColor getPatternThemeColor()

Returns the pattern color of the column.

Returns:

the pattern color of the column

See Also:

• setPatternColor(ThemeColor)

setPatternColor

public void setPatternColor(System.Drawing.Color color)

Sets the pattern color of the column.

Parameters:

color - the pattern color of the column

See Also:

• getPatternColor()

setPatternColor

public void setPatternColor(ThemeColor themeColor)

Sets the pattern color of the column.
This method is overridden as setPatternColor_2 in COM+ version of EasyXLS.

Parameters:

themeColor - the pattern color of the column

See Also:

• getPatternThemeColor()

getGradientColor1

public System.Drawing.Color getGradientColor1()

Returns the first color of the gradient fill.

Returns:

the first color of the gradient fill

See Also:

• setGradientFill(Color,Color,int)

getGradientColor2

public System.Drawing.Color getGradientColor2()

Returns the second color of the gradient fill.

Returns:

the second color of the gradient fill

See Also:

• setGradientFill(Color,Color,int)

setGradientFill

public void setGradientFill(System.Drawing.Color color1,
 System.Drawing.Color color2,
 int shadingStyle)

Sets the gradient fill for the style.

Parameters:

color1 - the first color of the gradient fill

color2 - the second color of the gradient fill

shadingStyle - the shading style of the gradient fill. Possible values are available in Fill class.

See Also:

• setGradientFill(ThemeColor, ThemeColor, int)
• getGradientColor1()
• getGradientColor2()
• getGradientShadingStyle()

getGradientThemeColor1

public ThemeColor getGradientThemeColor1()

Returns the first color of the gradient fill.

Returns:

the first color of the gradient fill

See Also:

• setGradientFill(ThemeColor,ThemeColor,int)

getGradientThemeColor2

public ThemeColor getGradientThemeColor2()

Returns the second color of the gradient fill.

Returns:

the second color of the gradient fill

See Also:

• setGradientFill(ThemeColor,ThemeColor,int)

setGradientFill

public void setGradientFill(ThemeColor themeColor1,
 ThemeColor themeColor2,
 int shadingStyle)

Sets the gradient fill for the style.

Parameters:

themeColor1 - the first color of the gradient fill

themeColor2 - the second color of the gradient fill

shadingStyle - the shading style of the gradient fill. Possible values are available in Fill class.

See Also:

• setGradientFill(Color, Color, int)
• getGradientThemeColor1()
• getGradientThemeColor2()
• getGradientShadingStyle()

getGradientShadingStyle

public int getGradientShadingStyle()

Returns the shading style of the gradient fill. Possible values are available in Fill class.

Returns:

the shading style of the gradient fill

See Also:

• setGradientFill(Color, Color, int)
• setGradientFill(ThemeColor, ThemeColor, int)

IsLocked

public bool IsLocked()

Returns the locked setting of the column.

Returns:

the locked setting of the column

See Also:

• setLocked(bool)

setLocked

public void setLocked(bool isLocked)

Sets the locked option of the column.

Parameters:

isLocked - the locked option of the column

See Also:

• IsLocked()

IsHiddenFormula

public bool IsHiddenFormula()

Returns the hidden setting of the column.

Returns:

the hidden setting of the column

See Also:

• setHiddenFormula(bool)

setHiddenFormula

public void setHiddenFormula(bool isHidden)

Sets the hidden option of the column.

Parameters:

isHidden - the hidden option of the column

See Also:

• IsHiddenFormula()

getOutlineLevel

public int getOutlineLevel()

Internal use only

Returns:

the outline level of the group

setOutlineLevel

public void setOutlineLevel(int nOutlineLevel)

Internal use only

Parameters:

nOutlineLevel - the outline level of the group

IsCollapsed

public bool IsCollapsed()

Internal use only

Returns:

true if the data group is collapsed, false otherwise

setCollapsed

public void setCollapsed(bool isCollapsed)

Internal use only

Parameters:

isCollapsed - true if the data group is collapsed, false otherwise

Clone

public ExcelColumn Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.