ActiveXLS
Class ExcelRow

System.Object
  ActiveXLS.ExcelRow

public class ExcelRow

extends System.Object

This class is a collection of cells. It allows to access the spreadsheet cells and to set the height of the row. Also, the row can be hidden and can have a style( 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, row cells locked or hidden, shrink, border type, border color).

Constructor Summary

ExcelRow()
Defines an instance of the row.

Method Summary

bool	AutoResize() Returns true if the row height will be automatically computed.
ExcelRow	Clone() Creates and returns a copy of this object.
int	Count() Returns the number of cells on a row.
void	esd_addCell(ExcelCell cell) Adds the specified cell to row.
ExcelCell	esd_getCell(int index) If a cell does not exist at the specified index, it creates a cell, and returns the cell from the specified index.
ExcelCell	esd_getCellAt(int index) Returns the cell from the specified index.
void	esd_insertCellAt(ExcelCell cell, int index) Inserts the specified cell at the specified index.
void	esd_removeCellAt(int index) Removes the cell from the specified index
void	esd_setCellAt(ExcelCell cell, int index) Sets the specified cell at the specified index.
System.Drawing.Color	getBackground() Returns the background color of the row.
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 row.
System.String	getFont() Returns the name of the row font.
int	getFontSize() Returns the size of the row font.
System.Drawing.Color	getForeground() Returns the foreground color of the row.
System.String	getFormat() Returns the number/date format of the row.
int	getHeight() Returns the height of the row.
System.String	getHorizontalAlignment() Returns the horizontal alignment of the row.
int	getIndent() Returns the indent of the row.
System.Drawing.Color	getLeftColor_Border() Returns the color of the left border.
int	getLeftStyle_Border() Returns the style of the left border.
int	getOutlineLevel() Internal use only
int	getPattern() Returns the pattern of the row.
System.Drawing.Color	getPatternColor() Returns the pattern color of the row.
System.Drawing.Color	getRightColor_Border() Returns the color of the right border.
int	getRightStyle_Border() Returns the style of the right border.
ExcelStyle	getStyle() Returns the style of the row.
int	getTextRotation() Returns the text rotation of the row.
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 row font.
System.String	getVerticalAlignment() Returns the vertical alignment of the row.
int	getXF() Internal use only
bool	IsBold() Returns the bold setting of the row font.
bool	IsCollapsed() Internal use only
bool	IsHiddenFormula() Returns the hidden setting of the row.
bool	IsHiddenRow() Returns the hidden option of the row.
bool	IsItalic() Returns the italic setting of the row font.
bool	IsLocked() Returns the locked setting of the row.
bool	IsShrink() Returns the shrink setting of the row.
bool	IsStrikethrough() Returns the strikethrough setting of the row font.
bool	IsSubscript() Returns the subscript setting of the row font.
bool	IsSuperscript() Returns the superscript setting of the row font.
bool	IsWrap() Returns the wrap setting of the row.
void	setAutoResize(bool isAutoResize) Sets the automatic calculation of the row height.
void	setBackground(System.Drawing.Color color) Sets the background color of the row.
void	setBold(bool isBold) Sets the bold option of the row 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 row.
void	setBorderStyles(int borderTop, int borderBottom, int borderLeft, int borderRight) Sets the border styles of the row.
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 row.
void	setFont(System.String fontName) Sets the name of the row font.
void	setFontSize(int fontSize) Sets the size of the row font.
void	setForeground(System.Drawing.Color color) Sets the foreground color of the row.
void	setFormat(System.String format) Sets the number/date format of the row.
void	setHeight(int height) Sets the height of the row.
void	setHiddenFormula(bool isHidden) Sets the hidden option of the row.
void	setHiddenRow(bool isHidden) Sets the hidden option of the row.
void	setHorizontalAlignment(System.String horizontalAlignment) Sets the horizontal alignment of the row.
void	setIndent(int indent) Sets the the indent of the row.
void	setItalic(bool isItalic) Sets the italic option of the row 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 row.
void	setOutlineLevel(int nOutlineLevel) Internal use only
void	setPattern(int pattern) Sets the pattern of the row.
void	setPatternColor(System.Drawing.Color color) Sets the pattern color of the row.
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 row.
void	setStrikethrough(bool isStrikethrough) Sets the strikethrough option of the row font.
void	setStyle(ExcelStyle xlsStyle) Sets the style of the row.
void	setSubscript(bool isSubscript) Sets the subscript option of the row font.
void	setSuperscript(bool isSuperscript) Sets the superscript option of the row font.
void	setTextRotation(int textRotation) Sets the text rotation of the row.
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 row font.
void	setVerticalAlignment(System.String verticalAlignment) Sets the vertical alignment of the row.
void	setWrap(bool isWrap) Sets the wrap option of the row.
void	setXF(int xfIndex) Internal use only

Constructor Detail

ExcelRow

public ExcelRow()

Defines an instance of the row.

Method Detail

esd_getCellAt

public ExcelCell esd_getCellAt(int index)

Returns the cell from the specified index.

Parameters:

index - the cell index

Returns:

the cell at specified index

See Also:

esd_setCellAt(ActiveXLS.ExcelCell, int), esd_removeCellAt(int), esd_insertCellAt(ActiveXLS.ExcelCell, int), esd_addCell(ActiveXLS.ExcelCell), esd_getCell(int)

esd_setCellAt

public void esd_setCellAt(ExcelCell cell,
                          int index)

Sets the specified cell at the specified index.

Parameters:

cell - the cell

index - the index where the cell will be set

See Also:

esd_getCellAt(int), esd_removeCellAt(int), esd_insertCellAt(ActiveXLS.ExcelCell, int), esd_addCell(ActiveXLS.ExcelCell), esd_getCell(int)

esd_removeCellAt

public void esd_removeCellAt(int index)

Removes the cell from the specified index

Parameters:

index - the index where the cell will be removed from

See Also:

esd_getCellAt(int), esd_setCellAt(ActiveXLS.ExcelCell, int), esd_insertCellAt(ActiveXLS.ExcelCell, int), esd_addCell(ActiveXLS.ExcelCell), esd_getCell(int)

esd_insertCellAt

public void esd_insertCellAt(ExcelCell cell,
                             int index)

Inserts the specified cell at the specified index.

Parameters:

cell - the cell to be inserted

index - the index where the cell will be inserted

See Also:

esd_getCellAt(int), esd_setCellAt(ActiveXLS.ExcelCell, int), esd_removeCellAt(int), esd_addCell(ActiveXLS.ExcelCell), esd_getCell(int)

esd_addCell

public void esd_addCell(ExcelCell cell)

Adds the specified cell to row.

Parameters:

cell - the cell to be added

See Also:

esd_getCellAt(int), esd_setCellAt(ActiveXLS.ExcelCell, int), esd_removeCellAt(int), esd_insertCellAt(ActiveXLS.ExcelCell, int), esd_getCell(int)

esd_getCell

public ExcelCell esd_getCell(int index)

If a cell does not exist at the specified index, it creates a cell, and returns the cell from the specified index.

Parameters:

index - the cell index

Returns:

the cell at specified index

See Also:

esd_getCellAt(int), esd_setCellAt(ActiveXLS.ExcelCell, int), esd_removeCellAt(int), esd_insertCellAt(ActiveXLS.ExcelCell, int), esd_addCell(ActiveXLS.ExcelCell)

getHeight

public int getHeight()

Returns the height of the row.

Returns:

the height of the row

See Also:

setHeight(int)

setHeight

public void setHeight(int height)

Sets the height of the row.

Parameters:

height - the height of the row

See Also:

getHeight()

Count

public int Count()

Returns the number of cells on a row.

Returns:

the number of cells on a row.

IsHiddenRow

public bool IsHiddenRow()

Returns the hidden option of the row.

Returns:

the hidden option of the row.

See Also:

setHiddenRow(bool)

setHiddenRow

public void setHiddenRow(bool isHidden)

Sets the hidden option of the row.

Parameters:

isHidden - the hidden option of the row

See Also:

IsHiddenRow()

AutoResize

public bool AutoResize()

Returns true if the row height will be automatically computed.

Returns:

true if the row height will be automatically computed.

See Also:

setAutoResize(bool)

setAutoResize

public void setAutoResize(bool isAutoResize)

Sets the automatic calculation of the row height.

Parameters:

isAutoResize - automatic calculation of the row height.

See Also:

AutoResize()

getDataType

public System.String getDataType()

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

See Also:

setDataType(System.String)

setDataType

public void setDataType(System.String dataType)

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

See Also:

getDataType()

getUnderlineStyle

public int getUnderlineStyle()

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

Returns:

the underline style of the row font

See Also:

setUnderlineStyle(int)

setUnderlineStyle

public void setUnderlineStyle(int UnderlineStyle)

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

Parameters:

UnderlineStyle - underline style of the row font

See Also:

getUnderlineStyle()

getFontSize

public int getFontSize()

Returns the size of the row font.

Returns:

the size of the row font

See Also:

setFontSize(int)

setFontSize

public void setFontSize(int fontSize)

Sets the size of the row font.

Parameters:

fontSize - the size of the row font

See Also:

getFontSize()

getFont

public System.String getFont()

Returns the name of the row font.

Returns:

the name of the row font

See Also:

setFont(System.String)

setFont

public void setFont(System.String fontName)

Sets the name of the row font.

Parameters:

fontName - the name of the row font

See Also:

getFont()

IsStrikethrough

public bool IsStrikethrough()

Returns the strikethrough setting of the row font.

Returns:

the strikethrough setting of the row font

See Also:

setStrikethrough(bool)

setStrikethrough

public void setStrikethrough(bool isStrikethrough)

Sets the strikethrough option of the row font.

Parameters:

isStrikethrough - the strikethrough option of the row font

See Also:

IsStrikethrough()

IsSubscript

public bool IsSubscript()

Returns the subscript setting of the row font.

Returns:

the subscript setting of the row font

See Also:

setSubscript(bool)

setSubscript

public void setSubscript(bool isSubscript)

Sets the subscript option of the row font.

Parameters:

isSubscript - the subscript option of the row font

See Also:

IsSubscript()

IsSuperscript

public bool IsSuperscript()

Returns the superscript setting of the row font.

Returns:

the superscript setting of the row font

See Also:

setSuperscript(bool)

setSuperscript

public void setSuperscript(bool isSuperscript)

Sets the superscript option of the row font.

Parameters:

isSuperscript - the superscript option of the row font

See Also:

IsSuperscript()

IsWrap

public bool IsWrap()

Returns the wrap setting of the row.

Returns:

the wrap setting of the row

See Also:

setWrap(bool)

setWrap

public void setWrap(bool isWrap)

Sets the wrap option of the row.

Parameters:

isWrap - the wrap option of the row

See Also:

IsWrap()

getBackground

public System.Drawing.Color getBackground()

Returns the background color of the row.

Returns:

the background color of the row

See Also:

setBackground(System.Drawing.Color)

setBackground

public void setBackground(System.Drawing.Color color)

Sets the background color of the row.

Parameters:

color - the background color of the row

See Also:

getBackground()

getForeground

public System.Drawing.Color getForeground()

Returns the foreground color of the row.

Returns:

the foreground color of the row

See Also:

setForeground(System.Drawing.Color)

setForeground

public void setForeground(System.Drawing.Color color)

Sets the foreground color of the row.

Parameters:

color - the foreground color of the row

See Also:

getForeground()

IsBold

public bool IsBold()

Returns the bold setting of the row font.

Returns:

the bold setting of the row font

See Also:

setBold(bool)

setBold

public void setBold(bool isBold)

Sets the bold option of the row font.

Parameters:

isBold - the bold option of the row font

See Also:

IsBold()

IsItalic

public bool IsItalic()

Returns the italic setting of the row font.

Returns:

the italic setting of the row font

See Also:

setItalic(bool)

setItalic

public void setItalic(bool isItalic)

Sets the italic option of the row font.

Parameters:

isItalic - the italic option of the row font

See Also:

IsItalic()

getHorizontalAlignment

public System.String getHorizontalAlignment()

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

Returns:

the horizontal alignment of the row

See Also:

setHorizontalAlignment(System.String)

setHorizontalAlignment

public void setHorizontalAlignment(System.String horizontalAlignment)

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

Parameters:

horizontalAlignment - the horizontal alignment of the row

See Also:

getHorizontalAlignment()

getVerticalAlignment

public System.String getVerticalAlignment()

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

Returns:

the vertical alignment of the row

See Also:

setVerticalAlignment(System.String)

setVerticalAlignment

public void setVerticalAlignment(System.String verticalAlignment)

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

Parameters:

verticalAlignment - the vertical alignment of the row

See Also:

getVerticalAlignment()

getTextRotation

public int getTextRotation()

Returns the text rotation of the row.

Returns:

the text rotation of the row

See Also:

setTextRotation(int)

setTextRotation

public void setTextRotation(int textRotation)

Sets the text rotation of the row.

Parameters:

textRotation - the text rotation of the row

See Also:

getTextRotation()

getIndent

public int getIndent()

Returns the indent of the row.

Returns:

the indent of the row.

See Also:

setIndent(int)

setIndent

public void setIndent(int indent)

Sets the the indent of the row.

Parameters:

indent - the indent of the row.

See Also:

getIndent()

getPattern

public int getPattern()

Returns the pattern of the row.

Returns:

the pattern of the row

See Also:

setPattern(int)

setPattern

public void setPattern(int pattern)

Sets the pattern of the row.

Parameters:

pattern - the pattern of the row

See Also:

getPattern()

getPatternColor

public System.Drawing.Color getPatternColor()

Returns the pattern color of the row.

Returns:

the pattern color of the row

See Also:

setPatternColor(System.Drawing.Color)

setPatternColor

public void setPatternColor(System.Drawing.Color color)

Sets the pattern color of the row.

Parameters:

color - the pattern color of the row

See Also:

getPatternColor()

getFormat

public System.String getFormat()

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

Returns:

the number/date format of the row

See Also:

setFormat(System.String)

setFormat

public void setFormat(System.String format)

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

Parameters:

format - the number/date format of the row

See Also:

getFormat()

IsLocked

public bool IsLocked()

Returns the locked setting of the row.

Returns:

the locked setting of the row

See Also:

setLocked(bool)

setLocked

public void setLocked(bool isLocked)

Sets the locked option of the row.

Parameters:

isLocked - the locked option of the row

See Also:

IsLocked()

IsShrink

public bool IsShrink()

Returns the shrink setting of the row.

Returns:

the shrink setting of the row

See Also:

setShrink(bool)

setShrink

public void setShrink(bool isShrink)

Sets the shrink option of the row.

Parameters:

isShrink - the shrink option of the row

See Also:

IsShrink()

IsHiddenFormula

public bool IsHiddenFormula()

Returns the hidden setting of the row.

Returns:

the hidden setting of the row

See Also:

setHiddenFormula(bool)

setHiddenFormula

public void setHiddenFormula(bool isHidden)

Sets the hidden option of the row.

Parameters:

isHidden - the hidden option of the row

See Also:

IsHiddenFormula()

setBorderStyles

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

Sets the border styles of the row. 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 row.

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)

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

getXF

public int getXF()

Internal use only

setXF

public void setXF(int xfIndex)

Internal use only

getStyle

public ExcelStyle getStyle()

Returns the style of the row.

Returns:

the style of the row

See Also:

setStyle(ActiveXLS.ExcelStyle)

setStyle

public void setStyle(ExcelStyle xlsStyle)

Sets the style of the row.

Parameters:

xlsStyle - the style of the row

See Also:

getStyle()

getOutlineLevel

public int getOutlineLevel()

Internal use only

setOutlineLevel

public void setOutlineLevel(int nOutlineLevel)

Internal use only

IsCollapsed

public bool IsCollapsed()

Internal use only

setCollapsed

public void setCollapsed(bool isCollapsed)

Internal use only

Clone

public ExcelRow Clone()

Creates and returns a copy of this object.

Returns:

a clone of this instance.