ActiveXLS
Class ExcelWorksheet

System.Object
  ActiveXLS.BIFF_Records.SheetStream
      ActiveXLS.ExcelSheet
          ActiveXLS.ExcelWorksheet

public class ExcelWorksheet

extends ExcelSheet

This class simulates a worksheet. Each worksheet contains a table, it has a title, and can be selected or protected.

Constructor Summary

ExcelWorksheet()
Defines an instance of the worksheet.

ExcelWorksheet(System.String sheetName)
Defines an instance of the worksheet that has the worksheet name defined.

Method Summary

int	ArrayFormulasCount() Returns the number of array formulas in the worksheet.
int	ChartCount() Returns the number of charts in the worksheet.
ExcelSheet	Clone() Creates and returns a copy of this object.
int	ConditionalFormattingCount() Returns the number of conditional formatting ranges in the worksheet.
int	DataGroupCount() Returns the number of data groups in the worksheet.
int	DataValidatorCount() Returns the number of data validators in the worksheet.
void	Dispose() Dispose any resources that it has allocated.
void	esd_addArrayFormula(int startRow, int startColumn, int endRow, int endColumn, System.String sFormula) Adds an array formula at the specified range to worksheet.
void	esd_addArrayFormula(System.String s2DRangeReference, System.String sFormula) Adds an array formula at the specified range to worksheet.
void	esd_addChart(ExcelChart xlsChart) Adds the specified chart to worksheet.
void	esd_addChart(ExcelChart xlsChart, int row, int column) Adds a chart that has the specified location to worksheet.
void	esd_addChart(ExcelChart xlsChart, int row, int column, int width, int height) Adds a chart that has the specified location and size to worksheet.
void	esd_addChart(ExcelChart xlsChart, System.String position) Adds a chart that has the specified location to worksheet.
void	esd_addChart(ExcelChart xlsChart, System.String position, int width, int height) Adds a chart that has the specified location and size to worksheet.
void	esd_addConditionalFormatting(ExcelConditionalFormatting xlsConditionalFormatting) Adds the specified conditional formatting range to worksheet.
void	esd_addConditionalFormatting(int firstRow, int firstColumn, int lastRow, int lastColumn, List lstConditions) Adds a conditional formatting at the specified range to worksheet.
void	esd_addConditionalFormatting(System.String range, int nOperator, System.String firstFormula, System.String secondFormula) Adds a conditional formatting having the specified range, operator and formula restrictions to worksheet.
void	esd_addConditionalFormatting(System.String range, int nOperator, System.String firstFormula, System.String secondFormula, bool isBold, bool isItalic, System.Drawing.Color foreground) Adds a conditional formatting having the specified range, operator, formulas restrictions and font settings to worksheet.
void	esd_addConditionalFormatting(System.String range, int nOperator, System.String firstFormula, System.String secondFormula, bool isBold, bool isItalic, System.Drawing.Color foreground, System.Drawing.Color background) Adds a conditional formatting having the specified range, operator, formulas restrictions, font settings and background to worksheet.
void	esd_addConditionalFormatting(System.String range, int nOperator, System.String firstFormula, System.String secondFormula, System.Drawing.Color background) Adds a conditional formatting having the specified range, operator, formulas restrictions and background to worksheet.
void	esd_addConditionalFormatting(System.String range, List lstConditions) Adds a conditional formatting at the specified range to worksheet.
void	esd_addDataGroup(ExcelDataGroup xlsGroup) Adds the specified data group to worksheet.
void	esd_addDataGroup(int firstRow, int firstColumn, int lastRow, int lastColumn, int groupRowsColumns, bool isCollapsed) Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.
void	esd_addDataGroup(int firstRow, int firstColumn, int lastRow, int lastColumn, int groupRowsColumns, bool isCollapsed, ExcelAutoFormat xlsAutoFormat) Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.
void	esd_addDataGroup(System.String range, int groupRowsColumns, bool isCollapsed) Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.
void	esd_addDataGroup(System.String range, int groupRowsColumns, bool isCollapsed, ExcelAutoFormat xlsAutoFormat) Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.
void	esd_addDataValidator(ExcelDataValidator xlsValidator) Adds the specified data validator to worksheet.
void	esd_addDataValidator(int firstRow, int firstColumn, int lastRow, int lastColumn, int validationType, int operatorType, System.String firstFormula, System.String secondFormula) Adds a data validator having the specified position, validation type, operator and formula restrictions to worksheet.
void	esd_addDataValidator(System.String range, int validationType, int operatorType, System.String firstFormula, System.String secondFormula) Adds a data validator having the specified position, validation type, operator and formulas restrictions to worksheet.
void	esd_addFooter(ExcelFooter xlsFooter) Adds the specified footer to worksheet.
void	esd_addFooter(System.String text, System.String position) Adds the footer having the specified text and position to worksheet.
void	esd_addFooter(System.String text, System.String position, System.String fontName, int fontSize, bool isBold, bool isItalic) Adds the footer having the specified text, position and font settings to worksheet.
void	esd_addHeader(ExcelHeader xlsHeader) Adds the specified header to worksheet.
void	esd_addHeader(System.String text, System.String position) Adds the header having the specified text and position to worksheet.
void	esd_addHeader(System.String text, System.String position, System.String fontName, int fontSize, bool isBold, bool isItalic) Adds the header having the specified text, position and font settings to worksheet.
void	esd_addHyperlink(ExcelHyperlink xlsHyperlink) Adds the specified hyperlink to worksheet.
void	esd_addHyperlink(System.String hyperlinkType, System.String url, System.String position) Adds a hyperlink having the specified type, url and position to worksheet.
void	esd_addHyperlink(System.String hyperlinkType, System.String url, System.String tooltip, System.String position) Adds a hyperlink having the specified type, url, tooltip and position to worksheet.
void	esd_addImage(ExcelImage xlsImage) Adds the specified image to worksheet.
void	esd_addImage(System.String path) Adds an image that has the specified path to worksheet.
void	esd_addImage(System.String path, int row, int column) Adds an image that has the specified path and location to worksheet.
void	esd_addImage(System.String path, int row, int column, int width, int height) Adds an image that has the specified path, location and size to worksheet.
void	esd_addImage(System.String path, System.String position) Adds an image that has the specified path and location to worksheet.
void	esd_addImage(System.String path, System.String position, int width, int height) Adds an image that has the specified path, location and size to worksheet.
void	esd_addName(ExcelName xlsName) Adds the specified name to worksheet.
void	esd_addName(System.String sNameText, System.String sRefersTo) Adds a name having the specified title and formula to worksheet.
System.String	esd_computeFormulas(ExcelDocument excel, bool bRecalculate) Calculates all formulas existing in the cells of this ExcelWorksheet
ExcelArrayFormula	esd_getArrayFormulaAt(int index) Returns the array formula from the specified index.
ExcelArrayFormula	esd_getArrayFormulaAt(int nRow, int nColumn) Returns the array formula located at the specified row number and row column.
ExcelArrayFormula	esd_getArrayFormulaAt(System.String range) Returns the array formula located at the specified range.
ExcelChart	esd_getChartAt(int index) Returns the chart from the specified index.
ExcelConditionalFormatting	esd_getConditionalFormattingAt(int index) Returns the conditional formatting range from the specified index.
ExcelConditionalFormatting	esd_getConditionalFormattingAt(System.String range) Returns the conditional formatting from the specified range.
ExcelDataGroup	esd_getDataGroupAt(int index) Returns the data group from the specified index.
ExcelDataGroup	esd_getDataGroupAt(System.String range) Returns the data group from the specified range.
ExcelDataValidator	esd_getDataValidatorAt(int index) Returns the data validator from the specified index.
ExcelDataValidator	esd_getDataValidatorAt(System.String range) Returns the data validator from the specified range.
ExcelTable	esd_getExcelTable() Returns the table of the worksheet.
ExcelFooter	esd_getFooterAt(int index) Returns the footer from the specified index.
ExcelFooter	esd_getFooterAt(System.String position) Returns the footer from the specified position.
ExcelHeader	esd_getHeaderAt(int index) Returns the header from the specified index.
ExcelHeader	esd_getHeaderAt(System.String position) Returns the header from the specified position.
ExcelHyperlink	esd_getHyperlinkAt(int index) Returns the hyperlink from the specified index.
ExcelHyperlink	esd_getHyperlinkAt(int nRow, int nColumn) Returns the hyperlink at the specified row index and column index.
ExcelHyperlink	esd_getHyperlinkAt(System.String position) Returns the hyperlink from the specified index.
ExcelImage	esd_getImage(System.String path) Returns the image that has the specified path.
ExcelImage	esd_getImageAt(int index) Returns the image from the specified index.
ExcelName	esd_getName(System.String sNameText) Returns the name having the specified title.
ExcelName	esd_getNameAt(int index) Returns the name from the specified index.
ExcelPageSetup	esd_getPageSetup() Returns the page setup options for the worksheet.
void	esd_insertList(List list) Inserts the data from the specified List object into this ExcelWorksheet starting from the first row and first column of the worksheet data table.
void	esd_insertList(List list, ExcelAutoFormat xlsAutoFormat) Inserts the data from the specified List object into this ExcelWorksheet starting from the first row and first column of the worksheet data table.
void	esd_insertList(List list, int startRow, int startCol) Inserts the data from the specified List object into this ExcelWorksheet starting from the startRow row index and startCol column index.
void	esd_insertList(List list, int startRow, int startCol, ExcelAutoFormat xlsAutoFormat) Inserts the data from the specified List object into this ExcelWorksheet starting from the startRow row index and startCol column index.
void	esd_insertList(List list, System.String startCellReference) Inserts the data from the specified List object into this ExcelWorksheet starting with the specified cell.
void	esd_insertList(List list, System.String startCellReference, ExcelAutoFormat xlsAutoFormat) Inserts the data from the specified List object into this ExcelWorksheet starting with the specified cell.
void	esd_insertDataSet(System.Data.DataSet rs, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting from first row and first column of the worksheet data table
void	esd_insertDataSet(System.Data.DataSet rs, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting from first row and first column of the worksheet data table.
void	esd_insertDataSet(System.Data.DataSet rs, int startRow, int startCol, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index
void	esd_insertDataSet(System.Data.DataSet rs, int startRow, int startCol, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index
void	esd_insertDataSet(System.Data.DataSet rs, System.String startCellReference, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting with the specified cell
void	esd_insertDataSet(System.Data.DataSet rs, System.String startCellReference, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) Inserts the data from the specified DataSet object into this ExcelWorksheet starting with the specified cell
void	esd_insertXMLFromFile(System.IO.Stream f) Inserts the XML data from the specified stream into this ExcelWorksheet starting from first row and first column of the worksheet data table
void	esd_insertXMLFromFile(System.IO.Stream f, int startRow, int startCol) Inserts the XML data from the specified stream into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index
void	esd_insertXMLFromFile(System.IO.Stream f, System.String startCellReference) Inserts the XML data from the specified stream into this ExcelWorksheet starting with the specified cell
void	esd_insertXMLFromFile(System.String path) Inserts the XML data from the specified XML file into this ExcelWorksheet starting from first row and first column of the worksheet data table
void	esd_insertXMLFromFile(System.String path, int startRow, int startCol) Inserts the XML data from the specified XML file into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index
void	esd_insertXMLFromFile(System.String path, System.String startCellReference) Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell
void	esd_insertXMLFromString(System.String xml) Inserts the XML data from the specified string into this ExcelWorksheet starting from first row and first column of the worksheet data table
void	esd_insertXMLFromString(System.String xml, int startRow, int startCol) Inserts the XML data from the specified string into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index
void	esd_insertXMLFromString(System.String xml, System.String startCellReference) Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell
void	esd_removeArrayFormula(int index) Removes the array formula from the specified index.
void	esd_removeArrayFormula(int startRow, int startColumn, int endRow, int endColumn) Removes the array formula located at the specified reference.
void	esd_removeArrayFormula(System.String s2DRangeReference) Removes the array formula located at the specified reference.
void	esd_removeChart(int index) Removes the chart from the specified index.
void	esd_removeConditionalFormatting(int index) Removes the conditional formatting range from the specified index.
void	esd_removeConditionalFormatting(System.String range) Removes the conditional formatting from the specified range.
void	esd_removeDataGroup(int index) Removes the data group from the specified index.
void	esd_removeDataGroup(System.String range) Removes the data group from the specified range.
void	esd_removeDataValidator(int index) Removes the data validator from the specified index.
void	esd_removeDataValidator(System.String range) Removes the data validator from the specified range.
void	esd_removeFooter(int index) Removes the footer from the specified index.
void	esd_removeFooter(System.String position) Removes the footer from the specified position.
void	esd_removeHeader(int index) Removes the header from the specified index.
void	esd_removeHeader(System.String position) Removes the header from the specified position.
void	esd_removeHyperlink(int index, bool clearCellValue) Removes the hyperlink from the specified index.
void	esd_removeHyperlink(System.String position, bool clearCellValue) Removes the hyperlink from the specified position.
void	esd_removeImage(int index) Removes the image from the specified index.
void	esd_removeImage(System.String path) Removes the image that has the specified path from the worksheet.
void	esd_removeName(int index) Removes the name from the specified index.
void	esd_removeName(System.String sNameText) Removes the name having the specified title.
void	esd_setExcelTable(ExcelTable xlsTable) Sets the table of the worksheet.
int	FooterCount() Returns the number of footers in the worksheet.
int	getColumnMaxOutlineLevel() Returns the highest number of outline levels for columns in this sheet.
int	getRowMaxOutlineLevel() Returns the highest number of outline levels for rows in this sheet.
int	HeaderCount() Returns the number of headers in the worksheet.
int	HyperlinkCount() Returns the number of hyperlinks in the worksheet.
int	ImageCount() Returns the number of images in the worksheet.
bool	IsDataGroupAutomaticStyles() Returns the automatic style option when grouping data.
bool	IsDataGroupSummaryColumnsRight() Returns true if the summary columns to right of detail option is set when grouping data, false otherwise.
bool	IsDataGroupSummaryRowsBelow() Returns true if the summary rows below detail option is set when grouping data, false otherwise.
bool	IsPageBreakPreview() Returns the page break preview option of the worksheet.
int	NameCount() Returns the number of names in the worksheet.
void	PopulateSheet() Populates the BIFF list by the default BIFF records for a worksheet.
void	RestoreDefaults()
void	setColumnMaxOutlineLevel(int nOutlineLevel) Sets the the highest number of outline levels for columns in this sheet.
void	setDataGroupAutomaticStyles(bool isDataGroupAutomaticStyles) Sets the automatic style option when grouping data.
void	setDataGroupSummaryColumnsRight(bool isDataGroupSummaryColumnsRight) Sets the summary columns to right of detail option when grouping data.
void	setDataGroupSummaryRowsBelow(bool isDataGroupSummaryRowsBelow) Sets the summary rows below detail option when grouping data.
void	setPageBreakPreview(bool isPageBreakPreview) Sets the page break preview option for the worksheet.
void	setRowMaxOutlineLevel(int nOutlineLevel) Sets the the highest number of outline levels for rows in this sheet.

Constructor Detail

ExcelWorksheet

public ExcelWorksheet()

Defines an instance of the worksheet.

ExcelWorksheet

public ExcelWorksheet(System.String sheetName)

Defines an instance of the worksheet that has the worksheet name defined.

Parameters:

sheetName - the worksheet name

Method Detail

esd_addConditionalFormatting

public void esd_addConditionalFormatting(ExcelConditionalFormatting xlsConditionalFormatting)

Adds the specified conditional formatting range to worksheet.

Parameters:

xlsConditionalFormatting - the conditional formatting range to be added

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(int firstRow,
                                         int firstColumn,
                                         int lastRow,
                                         int lastColumn,
                                         List lstConditions)

Adds a conditional formatting at the specified range to worksheet.

Parameters:

firstRow - first row index of the cells range

firstColumn - first column index of the cells range

lastRow - last row index of the cells range

lastColumn - last column index of the cells range

lstConditions - a list of ExcelCondition objects

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(System.String range,
                                         List lstConditions)

Adds a conditional formatting at the specified range to worksheet.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

lstConditions - a list of ExcelCondition objects

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(System.String range,
                                         int nOperator,
                                         System.String firstFormula,
                                         System.String secondFormula)

Adds a conditional formatting having the specified range, operator and formula restrictions to worksheet.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

nOperator - the conditional formatting operator. Possible values are available in ConditionalFormatting class.

firstFormula - the conditional formatting first formula

secondFormula - the conditional formatting second formula

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(System.String range,
                                         int nOperator,
                                         System.String firstFormula,
                                         System.String secondFormula,
                                         bool isBold,
                                         bool isItalic,
                                         System.Drawing.Color foreground)

Adds a conditional formatting having the specified range, operator, formulas restrictions and font settings to worksheet.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

nOperator - the conditional formatting operator. Possible values are available in ConditionalFormatting class.

firstFormula - the conditional formatting first formula

secondFormula - the conditional formatting second formula

isBold - the bold setting of the conditional formatting font

isItalic - the italic setting of the conditional formatting font

foreground - the foreground of the conditional formatting font

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(System.String range,
                                         int nOperator,
                                         System.String firstFormula,
                                         System.String secondFormula,
                                         bool isBold,
                                         bool isItalic,
                                         System.Drawing.Color foreground,
                                         System.Drawing.Color background)

Adds a conditional formatting having the specified range, operator, formulas restrictions, font settings and background to worksheet.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

nOperator - the conditional formatting operator. Possible values are available in ConditionalFormatting class.

firstFormula - the conditional formatting first formula

secondFormula - the conditional formatting second formula

isBold - the bold setting of the conditional formatting font

isItalic - the italic setting of the conditional formatting font

foreground - the foreground of the conditional formatting font

background - the color of the conditional formatting background

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_addConditionalFormatting

public void esd_addConditionalFormatting(System.String range,
                                         int nOperator,
                                         System.String firstFormula,
                                         System.String secondFormula,
                                         System.Drawing.Color background)

Adds a conditional formatting having the specified range, operator, formulas restrictions and background to worksheet.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

nOperator - the conditional formatting operator. Possible values are available in ConditionalFormatting class.

firstFormula - the conditional formatting first formula

secondFormula - the conditional formatting second formula

background - the color of the conditional formatting background

See Also:

ConditionalFormattingCount(), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

ConditionalFormattingCount

public int ConditionalFormattingCount()

Returns the number of conditional formatting ranges in the worksheet.

Returns:

the number of conditional formatting ranges in the worksheet

See Also:

esd_addConditionalFormatting(ActiveXLS.ExcelConditionalFormatting), esd_removeConditionalFormatting(int), esd_getConditionalFormattingAt(int)

esd_removeConditionalFormatting

public void esd_removeConditionalFormatting(int index)

Removes the conditional formatting range from the specified index.

Parameters:

index - the index of the conditional formatting to remove

See Also:

esd_addConditionalFormatting(ActiveXLS.ExcelConditionalFormatting), ConditionalFormattingCount(), esd_getConditionalFormattingAt(int)

esd_removeConditionalFormatting

public void esd_removeConditionalFormatting(System.String range)

Removes the conditional formatting from the specified range.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

See Also:

esd_addConditionalFormatting(ActiveXLS.ExcelConditionalFormatting), ConditionalFormattingCount(), esd_getConditionalFormattingAt(int)

esd_getConditionalFormattingAt

public ExcelConditionalFormatting esd_getConditionalFormattingAt(int index)

Returns the conditional formatting range from the specified index.

Parameters:

index - the index of the returned conditional formatting range

Returns:

the conditional formatting range with the specified index

See Also:

esd_addConditionalFormatting(ActiveXLS.ExcelConditionalFormatting), ConditionalFormattingCount(), esd_removeConditionalFormatting(int)

esd_getConditionalFormattingAt

public ExcelConditionalFormatting esd_getConditionalFormattingAt(System.String range)

Returns the conditional formatting from the specified range.

Parameters:

range - the area location of the conditional formatting. It can be a cell reference or a range.

Returns:

the conditional formatting range from the specified range

See Also:

esd_addConditionalFormatting(ActiveXLS.ExcelConditionalFormatting), ConditionalFormattingCount(), esd_removeConditionalFormatting(int)

esd_setExcelTable

public void esd_setExcelTable(ExcelTable xlsTable)

Sets the table of the worksheet.

Parameters:

xlsTable - the table of the worksheet

See Also:

esd_getExcelTable()

esd_getExcelTable

public ExcelTable esd_getExcelTable()

Returns the table of the worksheet.

Returns:

the table of the worksheet

See Also:

esd_setExcelTable(ActiveXLS.ExcelTable)

IsPageBreakPreview

public bool IsPageBreakPreview()

Returns the page break preview option of the worksheet.

Returns:

the page break preview option of the worksheet

See Also:

setPageBreakPreview(bool)

setPageBreakPreview

public void setPageBreakPreview(bool isPageBreakPreview)

Sets the page break preview option for the worksheet.

Parameters:

isPageBreakPreview - the page break preview option for the worksheet

See Also:

IsPageBreakPreview()

PopulateSheet

public void PopulateSheet()

Populates the BIFF list by the default BIFF records for a worksheet.

esd_addImage

public void esd_addImage(ExcelImage xlsImage)

Adds the specified image to worksheet.

Parameters:

xlsImage - the image to be added

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path)

Adds an image that has the specified path to worksheet.

Parameters:

path - the file path to image file

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         int row,
                         int column)

Adds an image that has the specified path and location to worksheet.

Parameters:

path - the file path to image file

row - the row number where the left upper corner of the image is anchored

column - the column number where the left upper corner of the image is anchored

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         int row,
                         int column,
                         int width,
                         int height)

Adds an image that has the specified path, location and size to worksheet.

Parameters:

path - the file path to image file

row - the row number where the left upper corner of the image is anchored

column - the column number where the left upper corner of the image is anchored

width - the image width

height - the image height

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         System.String position)

Adds an image that has the specified path and location to worksheet.

Parameters:

path - the file path to image file

position - the cell reference where the left upper corner of the image is anchored

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_addImage

public void esd_addImage(System.String path,
                         System.String position,
                         int width,
                         int height)

Adds an image that has the specified path, location and size to worksheet.

Parameters:

path - the file path to image file

position - the cell reference where the left upper corner of the image is anchored

width - the image width

height - the image height

See Also:

esd_removeImage(int), esd_getImageAt(int), ImageCount()

esd_removeImage

public void esd_removeImage(int index)

Removes the image from the specified index.

Parameters:

index - the index of the image to remove

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_getImageAt(int), ImageCount(), esd_removeImage(String)

esd_removeImage

public void esd_removeImage(System.String path)

Removes the image that has the specified path from the worksheet.

Parameters:

path - the file path to image file

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_getImageAt(int), ImageCount(), esd_removeImage(int)

esd_getImageAt

public ExcelImage esd_getImageAt(int index)

Returns the image from the specified index.

Parameters:

index - the index of the image to return

Returns:

the image from the specified index

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), ImageCount(), esd_getImage(String)

esd_getImage

public ExcelImage esd_getImage(System.String path)

Returns the image that has the specified path.

Parameters:

path - the file path to image file

Returns:

the image that has the specified path

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), ImageCount(), esd_getImageAt(int)

ImageCount

public int ImageCount()

Returns the number of images in the worksheet.

Returns:

the number of images in the worksheet

See Also:

esd_addImage(ActiveXLS.ExcelImage), esd_removeImage(int), esd_getImageAt(int)

esd_computeFormulas

public System.String esd_computeFormulas(ExcelDocument excel,
                                            bool bRecalculate)

Calculates all formulas existing in the cells of this ExcelWorksheet

Parameters:

excel - - the ExcelDocument which this ExcelWorksheet belongs to

bRecalculate - - a flag indicating if the cell formula should be recalculated. If the cell formula has never been calculated before, the formula will be processed even if the flag is false.

Returns:

the string error if any problems occured during the formula processing. During the formula processing the cellWorksheet and formulaWorksheet can be different if the cell formula contains table references from other worksheets

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting from first row and first column of the worksheet data table

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                ExcelAutoFormat xlsAutoFormat,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting from first row and first column of the worksheet data table. The inserted data has a specific autoformat.

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

xlsAutoFormat - the autoformat to be applied;

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                int startRow,
                                int startCol,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

startRow - the index of the row where the dataset data will be inserted from

startCol - the index of the column from where the dataset data will be inserted from

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                int startRow,
                                int startCol,
                                ExcelAutoFormat xlsAutoFormat,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

startRow - the index of the row where the dataset data will be inserted from

startCol - the index of the column where the dataset data will be inserted from

xlsAutoFormat - the autoformat to be applied

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                System.String startCellReference,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting with the specified cell

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

startCellReference - the cell where the DataSet values will be inserted from

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertDataSet

public void esd_insertDataSet(System.Data.DataSet rs,
                                System.String startCellReference,
                                ExcelAutoFormat xlsAutoFormat,
                                bool includeColumnNames)
                         

Inserts the data from the specified DataSet object into this ExcelWorksheet starting with the specified cell

Parameters:

rs - the DataSet to be inserted; only the data from the first table of the DataSet will be inserted

startCellReference - the cell from where the DataSet values will be inserted

xlsAutoFormat - the autoformat to be applied

includeColumnNames - true if the DataSet column names should be inserted false otherwise

Throws:

System.Exception

esd_insertList

public void esd_insertList(List list)

Inserts the data from the specified List object into this ExcelWorksheet starting from the first row and first column of the worksheet data table. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

See Also:

esd_insertList(List, int, int), esd_insertList(List, String)

esd_insertList

public void esd_insertList(List list,
                           ExcelAutoFormat xlsAutoFormat)

Inserts the data from the specified List object into this ExcelWorksheet starting from the first row and first column of the worksheet data table. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

xlsAutoFormat - the autoformat to be applied

See Also:

esd_insertList(List, int, int), esd_insertList(List, String)

esd_insertList

public void esd_insertList(List list,
                           int startRow,
                           int startCol)

Inserts the data from the specified List object into this ExcelWorksheet starting from the startRow row index and startCol column index. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

startRow - the index of the row where data will be inserted from

startCol - the index of the column where data will be inserted from

See Also:

esd_insertList(List), esd_insertList(List, String)

esd_insertList

public void esd_insertList(List list,
                           int startRow,
                           int startCol,
                           ExcelAutoFormat xlsAutoFormat)

Inserts the data from the specified List object into this ExcelWorksheet starting from the startRow row index and startCol column index. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

startRow - the index of the row where data will be inserted from

startCol - the index of the column where data will be inserted from

xlsAutoFormat - the autoformat to be applied

See Also:

esd_insertList(List), esd_insertList(List, String)

esd_insertList

public void esd_insertList(List list,
                           System.String startCellReference)

Inserts the data from the specified List object into this ExcelWorksheet starting with the specified cell. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

startCellReference - the cell where data will be inserted from

See Also:

esd_insertList(List), esd_insertList(List, int, int)

esd_insertList

public void esd_insertList(List list,
                           System.String startCellReference,
                           ExcelAutoFormat xlsAutoFormat)

Inserts the data from the specified List object into this ExcelWorksheet starting with the specified cell. The list must be a list of rows, each row is an ActiveXLS.Util.List object and each row must contain the values.

Parameters:

list - the List to be inserted

startCellReference - the cell where data will be inserted from

xlsAutoFormat - the autoformat to be applied

See Also:

esd_insertList(List), esd_insertList(List, int, int)

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.String path)
                           

Inserts the XML data from the specified XML file into this ExcelWorksheet starting from first row and first column of the worksheet data table

Parameters:

path - the path to the XML document.

Throws:

System.Exception

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.String path,
                                  int startRow,
                                  int startCol)
                           

Inserts the XML data from the specified XML file into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index

Parameters:

path - the path to the XML document.

startRow - the index of the row that the XML data will be inserted from

startCol - the index of the column that the XML data will be inserted from

Throws:

System.Exception

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.String path,
                                  System.String startCellReference)
                           

Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell

Parameters:

path - the path to the XML document.

startCellReference - the cell where the XML data will be inserted from

Throws:

System.Exception

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.IO.Stream f)
                           

Inserts the XML data from the specified stream into this ExcelWorksheet starting from first row and first column of the worksheet data table

Parameters:

f - the stream that points to the XML document.

Throws:

System.Exception

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.IO.Stream f,
                                  int startRow,
                                  int startCol)
                           

Inserts the XML data from the specified stream into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index

Parameters:

f - the stream that points to the XML document.

startRow - the index of the row that the XML data will be inserted from

startCol - the index of the column that the XML data will be inserted from

Throws:

System.Exception

esd_insertXMLFromFile

public void esd_insertXMLFromFile(System.IO.Stream f,
                                  System.String startCellReference)
                           

Inserts the XML data from the specified stream into this ExcelWorksheet starting with the specified cell

Parameters:

f - the stream that points to the XML document.

startCellReference - the cell where the XML data will be inserted from

Throws:

System.Exception

esd_insertXMLFromString

public void esd_insertXMLFromString(System.String xml)

Inserts the XML data from the specified string into this ExcelWorksheet starting from first row and first column of the worksheet data table

Parameters:

xml - the string in XML format

esd_insertXMLFromString

public void esd_insertXMLFromString(System.String xml,
                                    int startRow,
                                    int startCol)

Inserts the XML data from the specified string into this ExcelWorksheet starting from the nStartRow row index and nStartCol column index

Parameters:

xml - the string in XML format

startRow - the index of the row that the XML data will be inserted from

startCol - the index of the column that the XML data will be inserted from

esd_insertXMLFromString

public void esd_insertXMLFromString(System.String xml,
                                    System.String startCellReference)

Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell

Parameters:

xml - the string in XML format

startCellReference - the cell from where the XML data will be inserted

esd_addArrayFormula

public void esd_addArrayFormula(System.String s2DRangeReference,
                                System.String sFormula)

Adds an array formula at the specified range to worksheet.

Parameters:

s2DRangeReference - the area location of the array formula. It can only be a range of cells (e.g. A1:B2).

sFormula - the formula of the entered as an array; it should start with = (an equal sign) and it can be any kind of formula recognized by Excel

See Also:

esd_addArrayFormula(int,int,int,int,String)

esd_addArrayFormula

public void esd_addArrayFormula(int startRow,
                                int startColumn,
                                int endRow,
                                int endColumn,
                                System.String sFormula)

Adds an array formula at the specified range to worksheet.

Parameters:

startRow - the first row of the range where the array formula is entered

startColumn - the first column of the range where the array formula is entered

endRow - the last row of the range where the array formula is entered

endColumn - the last column of the range where the array formula is entered

sFormula - the formula of the entered as an array; it should start with = (an equal sign) and it can be any kind of formula recognized by Excel

See Also:

esd_addArrayFormula(String,String)

ArrayFormulasCount

public int ArrayFormulasCount()

Returns the number of array formulas in the worksheet.

Returns:

the number of array formulas in the worksheet

esd_removeArrayFormula

public void esd_removeArrayFormula(int index)

Removes the array formula from the specified index.

Parameters:

index - the index of the array formula to remove

See Also:

esd_removeArrayFormula(String), esd_removeArrayFormula(int, int, int, int)

esd_removeArrayFormula

public void esd_removeArrayFormula(System.String s2DRangeReference)

Removes the array formula located at the specified reference.

Parameters:

s2DRangeReference - the location where the array formula is entered. It can only be a range of cells (e.g. A1:B2).

See Also:

esd_removeArrayFormula(int, int, int, int), esd_removeArrayFormula(int)

esd_removeArrayFormula

public void esd_removeArrayFormula(int startRow,
                                   int startColumn,
                                   int endRow,
                                   int endColumn)

Removes the array formula located at the specified reference.

Parameters:

startRow - the first row of the range where the array formula is entered

startColumn - the first column of the range where the array formula is entered

endRow - the last row of the range where the array formula is entered

endColumn - the last column of the range where the array formula is entered

See Also:

esd_removeArrayFormula(int)

esd_getArrayFormulaAt

public ExcelArrayFormula esd_getArrayFormulaAt(int nRow,
                                               int nColumn)

Returns the array formula located at the specified row number and row column.

Parameters:

nRow - the row index of the cell that can be part of an array formula

nColumn - the column index of the cell that can be part of an array formula

Returns:

the array formula from the specified row and column.This method will return a null object if the cell defined by the nRow and nCol is outside of the array formula range.

esd_getArrayFormulaAt

public ExcelArrayFormula esd_getArrayFormulaAt(System.String range)

Returns the array formula located at the specified range.

Parameters:

range - the area location of the array formula. It can be a cell reference or a range.

Returns:

the array formula from the specified range. This method will return a null object if the specified range is entire or has cells outside the array formula range.

esd_getArrayFormulaAt

public ExcelArrayFormula esd_getArrayFormulaAt(int index)

Returns the array formula from the specified index.

Parameters:

index - the index of the array formula to return

Returns:

the array formula from the specified index

esd_addName

public void esd_addName(ExcelName xlsName)

Adds the specified name to worksheet.

Parameters:

xlsName - the name to be added

See Also:

esd_addName(String,String), esd_removeName(int), esd_removeName(String), esd_getNameAt(int), esd_getName(System.String), NameCount()

esd_addName

public void esd_addName(System.String sNameText,
                        System.String sRefersTo)

Adds a name having the specified title and formula to worksheet.

Parameters:

sNameText - the title of the name

sRefersTo - the formula of the name; should start with = (an equal sign) and can be any kind of formula recognized by Excel

See Also:

esd_addName(ExcelName), esd_removeName(int), esd_removeName(String), esd_getNameAt(int), esd_getName(System.String), NameCount()

esd_removeName

public void esd_removeName(int index)

Removes the name from the specified index.

Parameters:

index - the index of the name to remove

See Also:

esd_addName(ExcelName), esd_addName(String,String), esd_removeName(String), esd_getNameAt(int), esd_getName(System.String), NameCount()

esd_removeName

public void esd_removeName(System.String sNameText)

Removes the name having the specified title.

Parameters:

sNameText - the title of the name

See Also:

esd_addName(ExcelName), esd_addName(String,String), esd_removeName(int), esd_getNameAt(int), esd_getName(System.String), NameCount()

esd_getNameAt

public ExcelName esd_getNameAt(int index)

Returns the name from the specified index.

Parameters:

index - the index of the name to return

Returns:

the name from the specified index

See Also:

esd_addName(ExcelName), esd_addName(String,String), esd_removeName(int), esd_removeName(String), esd_getName(System.String), NameCount()

esd_getName

public ExcelName esd_getName(System.String sNameText)

Returns the name having the specified title.

Parameters:

sNameText - the title of the name

Returns:

the name from the specified title

See Also:

esd_addName(ExcelName), esd_addName(String,String), esd_removeName(int), esd_removeName(String), esd_getNameAt(int), NameCount()

NameCount

public int NameCount()

Returns the number of names in the worksheet.

Returns:

the number of names in the worksheet

See Also:

esd_addName(ExcelName), esd_addName(String,String), esd_removeName(int), esd_removeName(String), esd_getNameAt(int), esd_getName(System.String), NameCount()

esd_getPageSetup

public ExcelPageSetup esd_getPageSetup()

Returns the page setup options for the worksheet.

Returns:

the page setup options for the worksheet

esd_addDataValidator

public void esd_addDataValidator(ExcelDataValidator xlsValidator)

Adds the specified data validator to worksheet.

Parameters:

xlsValidator - the data validator to be added

See Also:

esd_addDataValidator(String,int,int,String,String), esd_addDataValidator(int,int,int,int,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String), DataValidatorCount()

esd_addDataValidator

public void esd_addDataValidator(int firstRow,
                                 int firstColumn,
                                 int lastRow,
                                 int lastColumn,
                                 int validationType,
                                 int operatorType,
                                 System.String firstFormula,
                                 System.String secondFormula)

Adds a data validator having the specified position, validation type, operator and formula restrictions to worksheet.

Parameters:

firstRow - the first row of the cell range where the validation will be applied

firstColumn - the first column of the cell range where the validation will be applied

lastRow - the last row of the cell range where the validation will be applied

lastColumn - the last column of the cell range where the validation will be applied

operatorType - the operator type. Possible values are available in DataValidator class.

validationType - the validation type. Possible values are available in DataValidator class.

firstFormula - the expression of the first formula

secondFormula - the expression of the second formula

See Also:

esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String), DataValidatorCount()

esd_addDataValidator

public void esd_addDataValidator(System.String range,
                                 int validationType,
                                 int operatorType,
                                 System.String firstFormula,
                                 System.String secondFormula)

Adds a data validator having the specified position, validation type, operator and formulas restrictions to worksheet.

Parameters:

range - the area location of the data validator. It can be a cell reference or a range.

operatorType - the operator type. Possible values are available in DataValidator class.

validationType - the validation type. Possible values are available in DataValidator class.

firstFormula - the expression of the first formula

secondFormula - the expression of the second formula

See Also:

esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(int,int,int,int,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String), DataValidatorCount()

esd_removeDataValidator

public void esd_removeDataValidator(int index)

Removes the data validator from the specified index.

Parameters:

index - the index of the data validator to remove

See Also:

esd_removeDataValidator(String), esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String), DataValidatorCount()

esd_removeDataValidator

public void esd_removeDataValidator(System.String range)

Removes the data validator from the specified range.

Parameters:

range - the area location of the data validator. It can be a cell reference or a range.

See Also:

esd_removeDataValidator(int), esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String), DataValidatorCount()

esd_getDataValidatorAt

public ExcelDataValidator esd_getDataValidatorAt(int index)

Returns the data validator from the specified index.

Parameters:

index - index of the data validator to return

Returns:

the data validator from the specified index

See Also:

esd_getDataValidatorAt(String), esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), DataValidatorCount()

esd_getDataValidatorAt

public ExcelDataValidator esd_getDataValidatorAt(System.String range)

Returns the data validator from the specified range.

Parameters:

range - the area location of the data validator. It can be a cell reference or a range.

Returns:

the data validator from the specified range

See Also:

esd_getDataValidatorAt(int), esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), DataValidatorCount()

DataValidatorCount

public int DataValidatorCount()

Returns the number of data validators in the worksheet.

Returns:

the number of data validators in the worksheet

See Also:

esd_addDataValidator(ExcelDataValidator), esd_addDataValidator(String,int,int,String,String), esd_removeDataValidator(int), esd_removeDataValidator(String), esd_getDataValidatorAt(int), esd_getDataValidatorAt(String)

esd_addHyperlink

public void esd_addHyperlink(ExcelHyperlink xlsHyperlink)

Adds the specified hyperlink to worksheet.

Parameters:

xlsHyperlink - the hyperlink to be added

See Also:

esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

esd_addHyperlink

public void esd_addHyperlink(System.String hyperlinkType,
                             System.String url,
                             System.String position)

Adds a hyperlink having the specified type, url and position to worksheet.

Parameters:

hyperlinkType - the hyperlink type. Possible values are available in HyperlinkType class.

url - the URL value

position - the area location of the hyperlink. It can be a cell reference or a range.

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

esd_addHyperlink

public void esd_addHyperlink(System.String hyperlinkType,
                             System.String url,
                             System.String tooltip,
                             System.String position)

Adds a hyperlink having the specified type, url, tooltip and position to worksheet.

Parameters:

hyperlinkType - the hyperlink type. Possible values are available in HyperlinkType class.

url - the URL value

tooltip - the tool tip text

position - the area location of the hyperlink. It can be a cell reference or a range.

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

esd_removeHyperlink

public void esd_removeHyperlink(int index,
                                bool clearCellValue)

Removes the hyperlink from the specified index.

Parameters:

index - the index of the Hyperlink to remove

clearCellValue - true if it clears the cell value, false otherwise

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

esd_removeHyperlink

public void esd_removeHyperlink(System.String position,
                                bool clearCellValue)

Removes the hyperlink from the specified position.

Parameters:

position - the area location of the hyperlink. It can be a cell reference or a range.

clearCellValue - true if clears the cell value, false otherwise

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

esd_getHyperlinkAt

public ExcelHyperlink esd_getHyperlinkAt(int index)

Returns the hyperlink from the specified index.

Parameters:

index - the index of the hyperlink to return

Returns:

the hyperlink from the specified index

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(String), HyperlinkCount()

esd_getHyperlinkAt

public ExcelHyperlink esd_getHyperlinkAt(System.String position)

Returns the hyperlink from the specified index.

Parameters:

position - the area location of the hyperlink. It can be a cell reference or a range.

Returns:

the hyperlink from the specified index

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), HyperlinkCount()

esd_getHyperlinkAt

public ExcelHyperlink esd_getHyperlinkAt(int nRow,
                                         int nColumn)

Returns the hyperlink at the specified row index and column index.

Parameters:

nRow - the index of the row

nColumn - the index of the column

Returns:

the hyperlink at the specified row index and column index.

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String), HyperlinkCount()

HyperlinkCount

public int HyperlinkCount()

Returns the number of hyperlinks in the worksheet.

Returns:

the number of hyperlinks in the worksheet

See Also:

esd_addHyperlink(ExcelHyperlink), esd_addHyperlink(String,String,String), esd_addHyperlink(String,String,String,String), esd_removeHyperlink(int,bool), esd_removeHyperlink(String,bool), esd_getHyperlinkAt(int), esd_getHyperlinkAt(String)

esd_addHeader

public void esd_addHeader(ExcelHeader xlsHeader)

Adds the specified header to worksheet.

Parameters:

xlsHeader - the header to be added

See Also:

esd_addHeader(String,String), esd_addHeader(String,String,String,int,bool,bool), esd_removeHeader(int), esd_removeHeader(String), esd_getHeaderAt(int), esd_getHeaderAt(String), HeaderCount()

esd_addHeader

public void esd_addHeader(System.String text,
                          System.String position)

Adds the header having the specified text and position to worksheet.

Parameters:

text - the text from the header

position - the position of the header. Possible values are available in Header class.

See Also:

esd_addHeader(ExcelHeader), esd_addHeader(String,String,String,int,bool,bool), esd_removeHeader(int), esd_removeHeader(String), esd_getHeaderAt(int), esd_getHeaderAt(String), HeaderCount()

esd_addHeader

public void esd_addHeader(System.String text,
                          System.String position,
                          System.String fontName,
                          int fontSize,
                          bool isBold,
                          bool isItalic)

Adds the header having the specified text, position and font settings to worksheet.

Parameters:

text - the text from the header

position - the position of the header. Possible values are available in Header class.

fontName - the font name of the header

fontSize - the font size of the header

isBold - the bold option of the header

isItalic - the italic option of header

See Also:

esd_addHeader(ExcelHeader), esd_addHeader(String,String), esd_removeHeader(int), esd_removeHeader(String), esd_getHeaderAt(int), esd_getHeaderAt(String), HeaderCount()

esd_removeHeader

public void esd_removeHeader(int index)

Removes the header from the specified index.

Parameters:

index - the index of the header to remove

See Also:

esd_removeHeader(String), esd_addHeader(ExcelHeader), esd_addHeader(String,String), esd_addHeader(String,String,String,int,bool,bool), esd_getHeaderAt(int), esd_getHeaderAt(String), HeaderCount()

esd_removeHeader

public void esd_removeHeader(System.String position)

Removes the header from the specified position.

Parameters:

position - the position of the header. Possible values are available in Header class.

See Also:

esd_removeHeader(int), esd_addHeader(ExcelHeader), esd_addHeader(String,String), esd_addHeader(String,String,String,int,bool,bool), esd_getHeaderAt(int), esd_getHeaderAt(String), HeaderCount()

esd_getHeaderAt

public ExcelHeader esd_getHeaderAt(int index)

Returns the header from the specified index.

Parameters:

index - the index of the header to return

Returns:

the header from the specified index

See Also:

esd_getHeaderAt(String), esd_addHeader(ExcelHeader), esd_addHeader(String,String), esd_addHeader(String,String,String,int,bool,bool), esd_removeHeader(int), esd_removeHeader(String), esd_removeHeader(int), HeaderCount()

esd_getHeaderAt

public ExcelHeader esd_getHeaderAt(System.String position)

Returns the header from the specified position.

Parameters:

position - the position of the header. Possible values are available in Header class.

Returns:

the header from the specified position

See Also:

esd_getHeaderAt(int), esd_addHeader(ExcelHeader), esd_addHeader(String, String), esd_removeHeader(int), esd_removeHeader(String), HeaderCount()

HeaderCount

public int HeaderCount()

Returns the number of headers in the worksheet.

Returns:

the number of headers in the worksheet

See Also:

esd_addHeader(ExcelHeader), esd_addHeader(String, String), esd_removeHeader(int), esd_removeHeader(String), esd_getHeaderAt(int), esd_getHeaderAt(String)

esd_addFooter

public void esd_addFooter(ExcelFooter xlsFooter)

Adds the specified footer to worksheet.

Parameters:

xlsFooter - the footer to be added

See Also:

esd_addFooter(String,String), esd_addFooter(String,String,String,int,bool,bool), esd_removeFooter(int), esd_removeFooter(String), esd_getFooterAt(int), esd_getFooterAt(String), FooterCount()

esd_addFooter

public void esd_addFooter(System.String text,
                          System.String position)

Adds the footer having the specified text and position to worksheet.

Parameters:

text - the text from the footer

position - the position of the footer. Possible values are available in Footer class.

See Also:

esd_addFooter(ExcelFooter), esd_addFooter(String,String,String,int,bool,bool), esd_removeFooter(int), esd_removeFooter(String), esd_getFooterAt(int), esd_getFooterAt(String), FooterCount()

esd_addFooter

public void esd_addFooter(System.String text,
                          System.String position,
                          System.String fontName,
                          int fontSize,
                          bool isBold,
                          bool isItalic)

Adds the footer having the specified text, position and font settings to worksheet.

Parameters:

text - the text from the footer

position - the position of the footer. Possible values are available in Footer class.

fontName - the font name of the footer

fontSize - the font size of the footer

isBold - the bold option of the footer

isItalic - the italic option of footer

See Also:

esd_addFooter(ExcelFooter), esd_addFooter(String,String), esd_removeFooter(int), esd_removeFooter(String), esd_getFooterAt(int), esd_getFooterAt(String), FooterCount()

esd_removeFooter

public void esd_removeFooter(int index)

Removes the footer from the specified index.

Parameters:

index - the index of the footer to remove

See Also:

esd_removeFooter(String), esd_addFooter(ExcelFooter), esd_addFooter(String,String), esd_addFooter(String,String,String,int,bool,bool), esd_getFooterAt(int), esd_getFooterAt(String), FooterCount()

esd_removeFooter

public void esd_removeFooter(System.String position)

Removes the footer from the specified position.

Parameters:

position - the position of the footer. Possible values are available in Footer class.

See Also:

esd_removeFooter(int), esd_addFooter(ExcelFooter), esd_addFooter(String,String), esd_addFooter(String,String,String,int,bool,bool), esd_getFooterAt(int), esd_getFooterAt(String), FooterCount()

esd_getFooterAt

public ExcelFooter esd_getFooterAt(int index)

Returns the footer from the specified index.

Parameters:

index - the index of the footer to return

Returns:

the footer from the specified index

See Also:

esd_getFooterAt(String), esd_addFooter(ExcelFooter), esd_addFooter(String,String), esd_addFooter(String,String,String,int,bool,bool), esd_removeFooter(int), esd_removeFooter(String), FooterCount()

esd_getFooterAt

public ExcelFooter esd_getFooterAt(System.String position)

Returns the footer from the specified position.

Parameters:

position - the position of the footer. Possible values are available in Footer class.

Returns:

the footer from the specified position

See Also:

esd_getFooterAt(int), esd_addFooter(ExcelFooter), esd_addFooter(String, String), esd_addFooter(String,String,String,int,bool,bool), esd_removeFooter(int), esd_removeFooter(String), FooterCount()

FooterCount

public int FooterCount()

Returns the number of footers in the worksheet.

Returns:

the number of footers in the worksheet

See Also:

esd_addFooter(ExcelFooter), esd_addFooter(String,String), esd_addFooter(String,String,String,int,bool,bool), esd_removeFooter(int), esd_removeFooter(String), esd_getFooterAt(int)

esd_addChart

public void esd_addChart(ExcelChart xlsChart)

Adds the specified chart to worksheet.

Parameters:

xlsChart - the chart to be added

See Also:

esd_removeChart(int), esd_getChartAt(int), ChartCount()

esd_addChart

public void esd_addChart(ExcelChart xlsChart,
                         int row,
                         int column)

Adds a chart that has the specified location to worksheet.

Parameters:

xlsChart - the chart to be added

row - the row number where the left upper corner of the chart is anchored

column - the column number where the left upper corner of the chart is anchored

See Also:

esd_removeChart(int), esd_getChartAt(int), ChartCount()

esd_addChart

public void esd_addChart(ExcelChart xlsChart,
                         int row,
                         int column,
                         int width,
                         int height)

Adds a chart that has the specified location and size to worksheet.

Parameters:

xlsChart - the chart to be added

row - the row number where the left upper corner of the chart is anchored

column - the column number where the left upper corner of the chart is anchored

width - the chart width

height - the chart height

See Also:

esd_removeChart(int), esd_getChartAt(int), ChartCount()

esd_addChart

public void esd_addChart(ExcelChart xlsChart,
                         System.String position)

Adds a chart that has the specified location to worksheet.

Parameters:

xlsChart - the chart to be added

position - the cell reference where the left upper corner of the chart is anchored

See Also:

esd_removeChart(int), esd_getChartAt(int), ChartCount()

esd_addChart

public void esd_addChart(ExcelChart xlsChart,
                         System.String position,
                         int width,
                         int height)

Adds a chart that has the specified location and size to worksheet.

Parameters:

xlsChart - the chart to be added

position - the cell reference where the left upper corner of the chart is anchored

width - the chart width

height - the chart height

See Also:

esd_removeChart(int), esd_getChartAt(int), ChartCount()

esd_removeChart

public void esd_removeChart(int index)

Removes the chart from the specified index.

Parameters:

index - the index of the chart to remove

See Also:

esd_addChart(ActiveXLS.Charts.ExcelChart), esd_getChartAt(int), ChartCount()

esd_getChartAt

public ExcelChart esd_getChartAt(int index)

Returns the chart from the specified index.

Parameters:

index - the index of the chart to return

Returns:

the chart from the specified index

See Also:

esd_addChart(ActiveXLS.Charts.ExcelChart), esd_removeChart(int), ChartCount()

ChartCount

public int ChartCount()

Returns the number of charts in the worksheet.

Returns:

the number of charts in the worksheet

See Also:

esd_addChart(ActiveXLS.Charts.ExcelChart), esd_removeChart(int), esd_getChartAt(int)

getColumnMaxOutlineLevel

public int getColumnMaxOutlineLevel()

Returns the highest number of outline levels for columns in this sheet.

Returns:

the highest number of outline levels for columns in this sheet.

setColumnMaxOutlineLevel

public void setColumnMaxOutlineLevel(int nOutlineLevel)

Sets the the highest number of outline levels for columns in this sheet.

Parameters:

nOutlineLevel - the outline level

See Also:

getColumnMaxOutlineLevel()

getRowMaxOutlineLevel

public int getRowMaxOutlineLevel()

Returns the highest number of outline levels for rows in this sheet.

Returns:

the highest number of outline levels for rows in this sheet.

setRowMaxOutlineLevel

public void setRowMaxOutlineLevel(int nOutlineLevel)

Sets the the highest number of outline levels for rows in this sheet.

Parameters:

nOutlineLevel - the outline level

See Also:

getRowMaxOutlineLevel()

IsDataGroupAutomaticStyles

public bool IsDataGroupAutomaticStyles()

Returns the automatic style option when grouping data.

Returns:

the automatic style option when grouping data

See Also:

setDataGroupAutomaticStyles(bool)

setDataGroupAutomaticStyles

public void setDataGroupAutomaticStyles(bool isDataGroupAutomaticStyles)

Sets the automatic style option when grouping data.

Parameters:

isDataGroupAutomaticStyles - the automatic style option when grouping data.

See Also:

IsDataGroupAutomaticStyles()

IsDataGroupSummaryRowsBelow

public bool IsDataGroupSummaryRowsBelow()

Returns true if the summary rows below detail option is set when grouping data, false otherwise.

Returns:

true if the summary rows below detail option is set when grouping data, false otherwise

See Also:

setDataGroupSummaryRowsBelow(bool), IsDataGroupSummaryColumnsRight()

setDataGroupSummaryRowsBelow

public void setDataGroupSummaryRowsBelow(bool isDataGroupSummaryRowsBelow)

Sets the summary rows below detail option when grouping data.

Parameters:

isDataGroupSummaryRowsBelow - the summary rows below detail option when grouping data.

See Also:

IsDataGroupSummaryRowsBelow(), setDataGroupSummaryColumnsRight(bool)

IsDataGroupSummaryColumnsRight

public bool IsDataGroupSummaryColumnsRight()

Returns true if the summary columns to right of detail option is set when grouping data, false otherwise.

Returns:

true if the summary columns to right of detail option is set when grouping data, false otherwise

See Also:

setDataGroupSummaryColumnsRight(bool), IsDataGroupSummaryRowsBelow()

setDataGroupSummaryColumnsRight

public void setDataGroupSummaryColumnsRight(bool isDataGroupSummaryColumnsRight)

Sets the summary columns to right of detail option when grouping data.

Parameters:

isDataGroupSummaryColumnsRight - the summary columns to right of detail option when grouping data.

See Also:

IsDataGroupSummaryColumnsRight(), setDataGroupSummaryRowsBelow(bool)

esd_addDataGroup

public void esd_addDataGroup(ExcelDataGroup xlsGroup)

Adds the specified data group to worksheet.

Parameters:

xlsGroup - the data group to be added

See Also:

esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_addDataGroup

public void esd_addDataGroup(System.String range,
                             int groupRowsColumns,
                             bool isCollapsed)

Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.

Parameters:

range - the area location of the data group. It can be a cell reference or a range.

groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.

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

See Also:

esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_addDataGroup

public void esd_addDataGroup(int firstRow,
                             int firstColumn,
                             int lastRow,
                             int lastColumn,
                             int groupRowsColumns,
                             bool isCollapsed)

Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.

Parameters:

firstRow - first row index of the cells range

firstColumn - first column index of the cells range

lastRow - last row index of the cells range

lastColumn - last column index of the cells range

groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.

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

See Also:

esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_addDataGroup

public void esd_addDataGroup(System.String range,
                             int groupRowsColumns,
                             bool isCollapsed,
                             ExcelAutoFormat xlsAutoFormat)

Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.

Parameters:

range - the area location of the data group. It can be a cell reference or a range.

groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.

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

xlsAutoFormat - the autoformat to be applied

See Also:

esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_addDataGroup

public void esd_addDataGroup(int firstRow,
                             int firstColumn,
                             int lastRow,
                             int lastColumn,
                             int groupRowsColumns,
                             bool isCollapsed,
                             ExcelAutoFormat xlsAutoFormat)

Adds a data group having the specified position, grouping per rows or colums and collapse option to worksheet.

Parameters:

firstRow - first row index of the cells range

firstColumn - first column index of the cells range

lastRow - last row index of the cells range

lastColumn - last column index of the cells range

groupRowsColumns - the grouping per rows or columns option. Possible values are available in DataGroup class.

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

xlsAutoFormat - the autoformat to be applied

See Also:

esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_removeDataGroup

public void esd_removeDataGroup(int index)

Removes the data group from the specified index.

Parameters:

index - the index of the data group to remove

See Also:

esd_removeDataGroup(String), esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_removeDataGroup

public void esd_removeDataGroup(System.String range)

Removes the data group from the specified range.

Parameters:

range - the area location of the data group. It can be a cell reference or a range.

See Also:

esd_removeDataGroup(int), esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_getDataGroupAt(int), esd_getDataGroupAt(String), DataGroupCount()

esd_getDataGroupAt

public ExcelDataGroup esd_getDataGroupAt(int index)

Returns the data group from the specified index.

Parameters:

index - index of the data group to return

Returns:

the data group from the specified index

See Also:

esd_getDataGroupAt(String), esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), DataGroupCount()

esd_getDataGroupAt

public ExcelDataGroup esd_getDataGroupAt(System.String range)

Returns the data group from the specified range.

Parameters:

range - the area location of the data group. It can be a cell reference or a range.

Returns:

the data group from the specified range

See Also:

esd_getDataGroupAt(int), esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), DataGroupCount()

DataGroupCount

public int DataGroupCount()

Returns the number of data groups in the worksheet.

Returns:

the number of data groups in the worksheet

See Also:

esd_addDataGroup(ExcelDataGroup), esd_addDataGroup(String, int, bool), esd_addDataGroup(int, int, int, int, int, bool), esd_addDataGroup(String, int, bool, ExcelAutoFormat), esd_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat), esd_removeDataGroup(int), esd_removeDataGroup(String), esd_getDataGroupAt(int), esd_getDataGroupAt(String)

Dispose

public void Dispose()

Dispose any resources that it has allocated.

Overrides:

Dispose in class ExcelSheet

Clone

public ExcelSheet Clone()

Creates and returns a copy of this object.

Specified by:

Clone in class ExcelSheet

Returns:

a clone of this instance.

RestoreDefaults

public void RestoreDefaults()