Namespace EasyXLS

Class ExcelWorksheet

System.Object
EasyXLS.BIFF_Records.SheetStream
EasyXLS.ExcelSheet
EasyXLS.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

    Constructors
    Constructor
    Description
    Defines an instance of the worksheet.
    ExcelWorksheet​(System.String sheetName)
    Defines an instance of the worksheet that has the worksheet name defined.
  • Method Summary

    Modifier and Type
    Method
    Description
    bool
    Returns true if deleting columns is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if deleting rows is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if editing objects is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if editing scenarios is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if formatting cells is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if formatting columns is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if formatting rows is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if inserting columns is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if inserting hyperlinks is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if inserting rows is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if the selection of locked cells is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if the selection of unlocked cells is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if sorting is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if autofilter is allowed when the sheet is protected, false otherwise.
    bool
    Returns true if using pivot tables and pivot charts is allowed when the sheet is protected, false otherwise.
    int
    Returns the number of array formulas in the worksheet.
    int
    Returns the number of charts in the worksheet.
    Creates and returns a copy of this object.
    int
    Returns the number of conditional formatting ranges in the worksheet.
    int
    Returns the number of data groups in the worksheet.
    int
    Returns the number of data validators in the worksheet.
    void
    Disposes any resources that it has allocated.
    void
    easy_addArrayFormula​(int startRow, int startColumn, int endRow, int endColumn, System.String sFormula)
    Adds an array formula at the specified range to worksheet.
    This method is overridden as easy_addArrayFormula_2 in COM+ version of EasyXLS.
    void
    easy_addArrayFormula​(System.String s2DRangeReference, System.String sFormula)
    Adds an array formula at the specified range to worksheet.
    void
    Adds the specified chart to worksheet.
    void
    easy_addChart​(ExcelChart xlsChart, int row, int column)
    Adds a chart that has the specified location to worksheet.
    This method is overridden as easy_addChart_2 in COM+ version of EasyXLS.
    void
    easy_addChart​(ExcelChart xlsChart, int row, int column, int width, int height)
    Adds a chart that has the specified location and size to worksheet.
    This method is overridden as easy_addChart_3 in COM+ version of EasyXLS.
    void
    easy_addChart​(ExcelChart xlsChart, System.String position)
    Adds a chart that has the specified location to worksheet.
    This method is overridden as easy_addChart_4 in COM+ version of EasyXLS.
    void
    easy_addChart​(ExcelChart xlsChart, System.String position, int width, int height)
    Adds a chart that has the specified location and size to worksheet.
    This method is overridden as easy_addChart_5 in COM+ version of EasyXLS.
    void
    easy_addConditionalFormatting​(int firstRow, int firstColumn, int lastRow, int lastColumn, List lstConditions)
    Adds a conditional formatting at the specified range to worksheet.
    This method is overridden as easy_addConditionalFormatting_2 in COM+ version of EasyXLS.
    void
    Adds the specified conditional formatting range to worksheet.
    void
    easy_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.
    This method is overridden as easy_addConditionalFormatting_4 in COM+ version of EasyXLS.
    void
    easy_addConditionalFormatting​(System.String range, int nOperator, System.String firstFormula, System.String secondFormula, bool isBold, bool isItalic, ThemeColor foreground, ThemeColor background)
    Adds a conditional formatting having the specified range, operator, formulas restrictions, font settings and background to worksheet.
    This method is overridden as easy_addConditionalFormatting_6 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addConditionalFormatting_5 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addConditionalFormatting_7 in COM+ version of EasyXLS.
    void
    easy_addConditionalFormatting​(System.String range, int nOperator, System.String firstFormula, System.String secondFormula, ThemeColor background)
    Adds a conditional formatting having the specified range, operator, formulas restrictions and background to worksheet.
    This method is overridden as easy_addConditionalFormatting_8 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addConditionalFormatting_9 in COM+ version of EasyXLS.
    void
    easy_addConditionalFormatting​(System.String range, List lstConditions)
    Adds a conditional formatting at the specified range to worksheet.
    This method is overridden as easy_addConditionalFormatting_3 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addDataGroup_2 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addDataGroup_3 in COM+ version of EasyXLS.
    void
    Adds the specified data group to worksheet.
    void
    easy_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.
    This method is overridden as easy_addDataGroup_4 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addDataGroup_5 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addDataValidator_2 in COM+ version of EasyXLS.
    void
    Adds the specified data validator to worksheet.
    void
    easy_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.
    This method is overridden as easy_addDataValidator_3 in COM+ version of EasyXLS.
    void
    Adds the specified footer to worksheet.
    void
    easy_addFooter​(System.String text, System.String position)
    Adds the footer having the specified text and position to worksheet.
    This method is overridden as easy_addFooter_2 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addFooter_3 in COM+ version of EasyXLS.
    void
    Adds the specified header to worksheet.
    void
    easy_addHeader​(System.String text, System.String position)
    Adds the header having the specified text and position to worksheet.
    This method is overridden as easy_addHeader_2 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addHeader_3 in COM+ version of EasyXLS.
    void
    Adds the specified hyperlink to worksheet.
    void
    easy_addHyperlink​(System.String hyperlinkType, System.String url, System.String position)
    Adds a hyperlink having the specified type, url and position to worksheet.
    This method is overridden as easy_addHyperlink_2 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addHyperlink_3 in COM+ version of EasyXLS.
    void
    easy_addImage​(System.String path, int row, int column)
    Adds an image that has the specified path and location to worksheet.
    This method is overridden as easy_addImage_3 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_addImage_4 in COM+ version of EasyXLS.
    void
    easy_addImage​(System.String path, System.String position)
    Adds an image that has the specified path and location to worksheet.
    This method is overridden as easy_addImage_5 in COM+ version of EasyXLS.
    void
    easy_addImage​(System.String path, System.String position, int width, int height)
    Adds an image that has the specified path, location and size to worksheet.
    This method is overridden as easy_addImage_6 in COM+ version of EasyXLS.
    void
    easy_addName​(ExcelName xlsName)
    Adds the specified name to worksheet.
    void
    easy_addName​(System.String sNameText, System.String sRefersTo)
    Adds a name having the specified title and formula to worksheet.
    This method is overridden as easy_addName_2 in COM+ version of EasyXLS.
    void
    Adds a pivot chart to the worksheet.
    void
    Adds a pivot table to the worksheet.
    void
    easy_addPivotTable​(System.String name, System.String location, System.String sourceFormulaRange, ExcelDocument xls)
    Adds a pivot table having the specified name, location and data source to the worksheet.
    This method is overridden as easy_addPivotTable_2 in COM+ version of EasyXLS.
    System.String
    easy_computeFormulas​(ExcelDocument excel, bool recalculateFormula)
    Calculates all formulas existing in the cells of this ExcelWorksheet
    easy_getArrayFormulaAt​(int index)
    Returns the array formula from the specified index.
    This method is overridden as easy_getArrayFormulaAt_3 in COM+ version of EasyXLS.
    easy_getArrayFormulaAt​(int nRow, int nColumn)
    Returns the array formula located at the specified row number and row column.
    easy_getArrayFormulaAt​(System.String range)
    Returns the array formula located at the specified range.
    This method is overridden as easy_getArrayFormulaAt_2 in COM+ version of EasyXLS.
    easy_getChartAt​(int index)
    Returns the chart from the specified index.
    Returns the conditional formatting range from the specified index.
    easy_getConditionalFormattingAt​(System.String range)
    Returns the conditional formatting from the specified range.
    easy_getDataGroupAt​(int index)
    Returns the data group from the specified index.
    easy_getDataGroupAt​(System.String range)
    Returns the data group from the specified range.
    This method is overridden as easy_getDataGroupAt_2 in COM+ version of EasyXLS.
    Returns the data validator from the specified index.
    easy_getDataValidatorAt​(System.String range)
    Returns the data validator from the specified range.
    Returns the table of the worksheet.
    Returns the filter for the worksheet.
    easy_getFooterAt​(int index)
    Returns the footer from the specified index.
    easy_getFooterAt​(System.String position)
    Returns the footer from the specified position.
    easy_getHeaderAt​(int index)
    Returns the header from the specified index.
    easy_getHeaderAt​(System.String position)
    Returns the header from the specified position.
    easy_getHyperlinkAt​(int index)
    Returns the hyperlink from the specified index.
    easy_getHyperlinkAt​(int nRow, int nColumn)
    Returns the hyperlink at the specified row index and column index.
    This method is overridden as easy_getHyperlinkAt_2 in COM+ version of EasyXLS.
    easy_getHyperlinkAt​(System.String position)
    Returns the hyperlink from the specified index.
    This method is overridden as easy_getHyperlinkAt_3 in COM+ version of EasyXLS.
    easy_getName​(System.String sNameText)
    Returns the name having the specified title.
    easy_getNameAt​(int index)
    Returns the name from the specified index.
    Returns the page setup options for the worksheet.
    easy_getPivotTable​(System.String name)
    Returns the pivot table having the specified name.
    easy_getPivotTableAt​(int index)
    Returns the pivot table from the specified index.
    void
    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
    easy_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 EasyXLS.Util.List object and each row must contain the values.
    This method is overridden as easy_insertList_3 in COM+ version of EasyXLS.
    void
    easy_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 EasyXLS.Util.List object and each row must contain the values.
    This method is overridden as easy_insertList_4 in COM+ version of EasyXLS.
    void
    easy_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.
    This method is overridden as easy_insertList_2 in COM+ version of EasyXLS. The list must be a list of rows, each row is an EasyXLS.Util.List object and each row must contain the values.
    void
    easy_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 EasyXLS.Util.List object and each row must contain the values.
    This method is overridden as easy_insertList_5 in COM+ version of EasyXLS.
    void
    easy_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 EasyXLS.Util.List object and each row must contain the values.
    This method is overridden as easy_insertList_6 in COM+ version of EasyXLS.
    void
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    easy_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
    This method is overridden as easy_insertXMLFromFile_2 in COM+ version of EasyXLS.
    void
    easy_insertXMLFromFile​(System.String path, System.String startCellReference)
    Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell
    This method is overridden as easy_insertXMLFromFile_3 in COM+ version of EasyXLS.
    void
    easy_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
    easy_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
    This method is overridden as easy_insertXMLFromString_2 in COM+ version of EasyXLS.
    void
    easy_insertXMLFromString​(System.String xml, System.String startCellReference)
    Inserts the XML data from the specified XML file into this ExcelWorksheet starting with the specified cell
    This method is overridden as easy_insertXMLFromString_3 in COM+ version of EasyXLS.
    void
    Removes the array formula from the specified index.
    void
    easy_removeArrayFormula​(int startRow, int startColumn, int endRow, int endColumn)
    Removes the array formula located at the specified reference.
    This method is overridden as easy_removeArrayFormula_3 in COM+ version of EasyXLS.
    void
    easy_removeArrayFormula​(System.String s2DRangeReference)
    Removes the array formula located at the specified reference.
    This method is overridden as easy_removeArrayFormula_2 in COM+ version of EasyXLS.
    void
    easy_removeChart​(int index)
    Removes the chart from the specified index.
    void
    Removes the conditional formatting range from the specified index.
    void
    easy_removeConditionalFormatting​(System.String range)
    Removes the conditional formatting from the specified range.
    void
    easy_removeDataGroup​(int index)
    Removes the data group from the specified index.
    void
    easy_removeDataGroup​(System.String range)
    Removes the data group from the specified range.
    This method is overridden as easy_removeDataGroup_2 in COM+ version of EasyXLS.
    void
    Removes the data validator from the specified index.
    void
    easy_removeDataValidator​(System.String range)
    Removes the data validator from the specified range.
    This method is overridden as easy_removeDataValidator_2 in COM+ version of EasyXLS.
    void
    easy_removeFooter​(int index)
    Removes the footer from the specified index.
    void
    easy_removeFooter​(System.String position)
    Removes the footer from the specified position.
    void
    easy_removeHeader​(int index)
    Removes the header from the specified index.
    void
    easy_removeHeader​(System.String position)
    Removes the header from the specified position.
    void
    easy_removeHyperlink​(int index, bool clearCellValue)
    Removes the hyperlink from the specified index.
    void
    easy_removeHyperlink​(System.String position, bool clearCellValue)
    Removes the hyperlink from the specified position.
    This method is overridden as easy_removeHyperlink_2 in COM+ version of EasyXLS.
    void
    easy_removeName​(int index)
    Removes the name from the specified index.
    void
    easy_removeName​(System.String sNameText)
    Removes the name having the specified title.
    void
    easy_removePivotTable​(int index)
    Removes the pivot table from the specified index.
    void
    Sets the table of the worksheet.
    int
    Returns the number of footers in the worksheet.
    int
    Returns the highest number of outline levels for columns in this sheet.
    int
    Returns the highest number of outline levels for rows in this sheet.
    int
    Returns the number of headers in the worksheet.
    int
    Returns the number of hyperlinks in the worksheet.
    bool
    Returns the automatic style option when grouping data.
    bool
    Returns true if the summary columns to right of detail option is set when grouping data, false otherwise.
    bool
    Returns true if the summary rows below detail option is set when grouping data, false otherwise.
    bool
    Returns the page break preview option of the worksheet.
    int
    Returns the number of names in the worksheet.
    int
    Returns the number of pivot tables in the worksheet.
    void
    Populates the BIFF list by the default BIFF records for a worksheet.
    void
    Internal use only
    void
    setAllowDeleteColumns​(bool allow)
    Sets if deleting columns is allowed when the sheet is protected.
    void
    setAllowDeleteRows​(bool allow)
    Sets if deleting rows is allowed when the sheet is protected.
    void
    setAllowEditObjects​(bool allow)
    Sets if editing objects is allowed when the sheet is protected.
    void
    setAllowEditScenarios​(bool allow)
    Sets if editing scenarios is allowed when the sheet is protected.
    void
    setAllowFormatCells​(bool allow)
    Sets if formatting cells is allowed when the sheet is protected.
    void
    setAllowFormatColumns​(bool allow)
    Sets if formatting columns is allowed when the sheet is protected.
    void
    setAllowFormatRows​(bool allow)
    Sets if formatting rows is allowed when the sheet is protected.
    void
    setAllowInsertColumns​(bool allow)
    Sets if inserting columns is allowed when the sheet is protected.
    void
    setAllowInsertHyperlinks​(bool allow)
    Sets if inserting hyperlinks is allowed when the sheet is protected.
    void
    setAllowInsertRows​(bool allow)
    Sets if inserting rows is allowed when the sheet is protected.
    void
    Sets if the selection of locked cells is allowed when the sheet is protected.
    void
    Sets if the selection of unlocked cells is allowed when the sheet is protected.
    void
    setAllowSort​(bool allow)
    Sets if sorting is allowed when the sheet is protected.
    void
    setAllowUseAutofilter​(bool allow)
    Sets if autofilter is allowed when the sheet is protected.
    void
    setAllowUsePivots​(bool allow)
    Sets if using pivot tables and pivot charts is allowed when the sheet is protected.
    void
    setColumnMaxOutlineLevel​(int nOutlineLevel)
    Sets 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 highest number of outline levels for rows in this sheet.
    void
    setShowGridlines​(bool show)
    Sets the visibility option for the gridlines of the worksheet.
    bool
    Returns true if the gridlines are visible in a worksheet, false otherwise.

    Methods inherited from class EasyXLS.BIFF_Records.SheetStream

    biffList, BIFFsLength

    Methods inherited from class System.Object

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