Namespace EasyXLS
Class ExcelWorksheet
System.Object
EasyXLS.BIFF_Records.SheetStream
EasyXLS.ExcelSheet
EasyXLS.ExcelWorksheet
This class simulates a worksheet. Each worksheet contains a table, it has a title, and can be selected or protected.
-
Constructor Summary
ConstructorDescriptionDefines 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 TypeMethodDescriptionbool
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.Clone()
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
Dispose()
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
easy_addChart(ExcelChart xlsChart)
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
easy_addConditionalFormatting(ExcelConditionalFormatting xlsConditionalFormatting)
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
easy_addDataGroup(ExcelDataGroup xlsGroup)
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
easy_addDataValidator(ExcelDataValidator xlsValidator)
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
easy_addFooter(ExcelFooter xlsFooter)
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
easy_addHeader(ExcelHeader xlsHeader)
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
easy_addHyperlink(ExcelHyperlink xlsHyperlink)
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
easy_addPivotChart(ExcelPivotChart xlsPivotChart)
Adds a pivot chart to the worksheet.void
easy_addPivotTable(ExcelPivotTable xlsPivotTable)
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 ExcelWorksheeteasy_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.easy_getConditionalFormattingAt(int 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.
easy_getDataValidatorAt(int index)
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
easy_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
easy_insertList(List list, int startRow, int startCol)
Inserts the data from the specified List object into this ExcelWorksheet starting from thestartRow
row index andstartCol
column index.
Thelist
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 thestartRow
row index andstartCol
column index.
Thelist
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.
Thelist
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.
Thelist
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.
Thelist
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 tablevoid
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 thenStartRow
row index andnStartCol
column indexvoid
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 thenStartRow
row index andnStartCol
column indexvoid
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 cellvoid
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 cellvoid
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 tablevoid
easy_insertXMLFromFile(System.IO.Stream f, int startRow, int startCol)
Inserts the XML data from the specified stream into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
column indexvoid
easy_insertXMLFromFile(System.IO.Stream f, System.String startCellReference)
Inserts the XML data from the specified stream into this ExcelWorksheet starting with the specified cellvoid
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 tablevoid
easy_insertXMLFromFile(System.String path, int startRow, int startCol)
Inserts the XML data from the specified XML file into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
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 tablevoid
easy_insertXMLFromString(System.String xml, int startRow, int startCol)
Inserts the XML data from the specified string into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
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
easy_removeArrayFormula(int index)
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
easy_removeConditionalFormatting(int index)
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
easy_removeDataValidator(int index)
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
easy_setExcelTable(ExcelTable xlsTable)
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 onlyvoid
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
setAllowSelectLockedCells(bool allow)
Sets if the selection of locked cells is allowed when the sheet is protected.void
setAllowSelectUnlockedCells(bool allow)
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.ExcelSheet
easy_addImage, easy_addImage, easy_getImage, easy_getImageAt, easy_removeImage, easy_removeImage, getHashedPassword, getSheetName, getTabColor, getTabThemeColor, getZoom, ImageCount, IsHidden, IsSheetProtected, IsSheetSelected, setHashedPassword, setHidden, setProtectionPassword, setSheetName, setSheetProtected, setSheetSelected, setTabColor, setTabColor, setZoom
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
-
Constructor Details
-
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 Details
-
easy_addConditionalFormatting
Adds the specified conditional formatting range to worksheet.- Parameters:
xlsConditionalFormatting
- the conditional formatting range to be added- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- Parameters:
firstRow
- first row index of the cells rangefirstColumn
- first column index of the cells rangelastRow
- last row index of the cells rangelastColumn
- last column index of the cells rangelstConditions
- a list of ExcelCondition objects- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
Adds a conditional formatting at the specified range to worksheet.
This method is overridden as easy_addConditionalFormatting_3 in COM+ version of EasyXLS.
- 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()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formula- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formulaisBold
- the bold setting of the conditional formatting fontisItalic
- the italic setting of the conditional formatting fontforeground
- the foreground of the conditional formatting font- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formulaisBold
- the bold setting of the conditional formatting fontisItalic
- the italic setting of the conditional formatting fontforeground
- the foreground of the conditional formatting fontbackground
- the color of the conditional formatting background- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formulaisBold
- the bold setting of the conditional formatting fontisItalic
- the italic setting of the conditional formatting fontforeground
- the foreground of the conditional formatting fontbackground
- the color of the conditional formatting background- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formulabackground
- the color of the conditional formatting background- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_addConditionalFormatting
public 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.
- 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 inConditionalFormatting
class.firstFormula
- the conditional formatting first formulasecondFormula
- the conditional formatting second formulabackground
- the color of the conditional formatting background- See Also:
ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
,easy_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:
easy_addConditionalFormatting(EasyXLS.ExcelConditionalFormatting)
,easy_removeConditionalFormatting(int)
,easy_getConditionalFormattingAt(int)
-
easy_removeConditionalFormatting
public void easy_removeConditionalFormatting(int index)Removes the conditional formatting range from the specified index.- Parameters:
index
- the index of the conditional formatting to remove- See Also:
easy_addConditionalFormatting(EasyXLS.ExcelConditionalFormatting)
,ConditionalFormattingCount()
,easy_getConditionalFormattingAt(int)
-
easy_removeConditionalFormatting
public void easy_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:
easy_addConditionalFormatting(EasyXLS.ExcelConditionalFormatting)
,ConditionalFormattingCount()
,easy_getConditionalFormattingAt(int)
-
easy_getConditionalFormattingAt
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:
easy_addConditionalFormatting(EasyXLS.ExcelConditionalFormatting)
,ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
-
easy_getConditionalFormattingAt
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:
easy_addConditionalFormatting(EasyXLS.ExcelConditionalFormatting)
,ConditionalFormattingCount()
,easy_removeConditionalFormatting(int)
-
easy_setExcelTable
Sets the table of the worksheet.- Parameters:
xlsTable
- the table of the worksheet- See Also:
easy_getExcelTable()
-
easy_getExcelTable
Returns the table of the worksheet.- Returns:
- the table of the worksheet
- See Also:
easy_setExcelTable(EasyXLS.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()
-
ShowGridlines
public bool ShowGridlines()Returns true if the gridlines are visible in a worksheet, false otherwise.- Returns:
- true if the gridlines are visible in a worksheet, false otherwise
- See Also:
setShowGridlines(bool)
-
setShowGridlines
public void setShowGridlines(bool show)Sets the visibility option for the gridlines of the worksheet.- Parameters:
show
- true if the gridlines are visible in the worksheet, false otherwise.- See Also:
ShowGridlines()
-
PopulateSheet
public void PopulateSheet()Populates the BIFF list by the default BIFF records for a worksheet. -
easy_addImage
public 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.
- Parameters:
path
- the file path to image filerow
- the row number where the left upper corner of the image is anchoredcolumn
- the column number where the left upper corner of the image is anchored- See Also:
ExcelSheet.easy_removeImage(int)
,ExcelSheet.easy_getImageAt(int)
,ExcelSheet.ImageCount()
-
easy_addImage
public 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.
- Parameters:
path
- the file path to image filerow
- the row number where the left upper corner of the image is anchoredcolumn
- the column number where the left upper corner of the image is anchoredwidth
- the image widthheight
- the image height- See Also:
ExcelSheet.easy_removeImage(int)
,ExcelSheet.easy_getImageAt(int)
,ExcelSheet.ImageCount()
-
easy_addImage
public 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.
- Parameters:
path
- the file path to image fileposition
- the cell reference where the left upper corner of the image is anchored- See Also:
ExcelSheet.easy_removeImage(int)
,ExcelSheet.easy_getImageAt(int)
,ExcelSheet.ImageCount()
-
easy_addImage
public 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.
- Parameters:
path
- the file path to image fileposition
- the cell reference where the left upper corner of the image is anchoredwidth
- the image widthheight
- the image height- See Also:
ExcelSheet.easy_removeImage(int)
,ExcelSheet.easy_getImageAt(int)
,ExcelSheet.ImageCount()
-
easy_computeFormulas
Calculates all formulas existing in the cells of this ExcelWorksheet- Parameters:
excel
- - the ExcelDocument which this ExcelWorksheet belongs torecalculateFormula
- - 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
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, bool includeColumnNames) throws System.ExceptionInserts 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 insertedincludeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) throws System.ExceptionInserts 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 insertedxlsAutoFormat
- the autoformat to be applied;includeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, int startRow, int startCol, bool includeColumnNames) throws System.ExceptionInserts the data from the specified DataSet object into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
column index- Parameters:
rs
- the DataSet to be inserted; only the data from the first table of the DataSet will be insertedstartRow
- the index of the row where the dataset data will be inserted fromstartCol
- the index of the column where the dataset data will be inserted fromincludeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, int startRow, int startCol, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) throws System.ExceptionInserts the data from the specified DataSet object into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
column index- Parameters:
rs
- the DataSet to be inserted; only the data from the first table of the DataSet will be insertedstartRow
- the index of the row where the dataset data will be inserted fromstartCol
- the index of the column where the dataset data will be inserted fromxlsAutoFormat
- the autoformat to be appliedincludeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, System.String startCellReference, bool includeColumnNames) throws System.ExceptionInserts 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 insertedstartCellReference
- the cell where the DataSet values will be inserted fromincludeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertDataSet
public void easy_insertDataSet(System.Data.DataSet rs, System.String startCellReference, ExcelAutoFormat xlsAutoFormat, bool includeColumnNames) throws System.ExceptionInserts 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 insertedstartCellReference
- the cell where the DataSet values will be inserted fromxlsAutoFormat
- the autoformat to be appliedincludeColumnNames
- true if the DataSet column names should be inserted false otherwise- Throws:
System.Exception
- an error might be thrown
-
easy_insertList
Inserts the data from the specified List object into this ExcelWorksheet starting from the first row and first column of the worksheet data table. Thelist
must be a list of rows, each row is an EasyXLS.Util.List object and each row must contain the values.- Parameters:
list
- the List to be inserted- See Also:
easy_insertList(List, int, int)
,easy_insertList(List, String)
-
easy_insertList
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.
Thelist
must be a list of rows, each row is an EasyXLS.Util.List object and each row must contain the values.- Parameters:
list
- the List to be insertedxlsAutoFormat
- the autoformat to be applied- See Also:
easy_insertList(List, int, int)
,easy_insertList(List, String)
-
easy_insertList
Inserts the data from the specified List object into this ExcelWorksheet starting from thestartRow
row index andstartCol
column index.
Thelist
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.
- Parameters:
list
- the List to be insertedstartRow
- the index of the row where data will be inserted fromstartCol
- the index of the column where data will be inserted from- See Also:
easy_insertList(List)
,easy_insertList(List, String)
-
easy_insertList
Inserts the data from the specified List object into this ExcelWorksheet starting from thestartRow
row index andstartCol
column index.
Thelist
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.
- Parameters:
list
- the List to be insertedstartRow
- the index of the row where data will be inserted fromstartCol
- the index of the column where data will be inserted fromxlsAutoFormat
- the autoformat to be applied- See Also:
easy_insertList(List)
,easy_insertList(List, String)
-
easy_insertList
Inserts the data from the specified List object into this ExcelWorksheet starting with the specified cell.
Thelist
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.
- Parameters:
list
- the List to be insertedstartCellReference
- the cell where data will be inserted from- See Also:
easy_insertList(List)
,easy_insertList(List, int, int)
-
easy_insertList
public 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.
Thelist
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.
- Parameters:
list
- the List to be insertedstartCellReference
- the cell where data will be inserted fromxlsAutoFormat
- the autoformat to be applied- See Also:
easy_insertList(List)
,easy_insertList(List, int, int)
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.String path) throws System.ExceptionInserts 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
- an error might be thrown
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.String path, int startRow, int startCol) throws System.ExceptionInserts the XML data from the specified XML file into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
column index
This method is overridden as easy_insertXMLFromFile_2 in COM+ version of EasyXLS.
- Parameters:
path
- the path to the XML document.startRow
- the index of the row that the XML data will be inserted fromstartCol
- the index of the column that the XML data will be inserted from- Throws:
System.Exception
- an error might be thrown
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.String path, System.String startCellReference) throws System.ExceptionInserts 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.
- Parameters:
path
- the path to the XML document.startCellReference
- the cell where the XML data will be inserted from- Throws:
System.Exception
- an error might be thrown
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.IO.Stream f) throws System.ExceptionInserts 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
- an error might be thrown
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.IO.Stream f, int startRow, int startCol) throws System.ExceptionInserts the XML data from the specified stream into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
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 fromstartCol
- the index of the column that the XML data will be inserted from- Throws:
System.Exception
- an error might be thrown
-
easy_insertXMLFromFile
public void easy_insertXMLFromFile(System.IO.Stream f, System.String startCellReference) throws System.ExceptionInserts 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
- an error might be thrown
-
easy_insertXMLFromString
public 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- Parameters:
xml
- the string in XML format
-
easy_insertXMLFromString
public void easy_insertXMLFromString(System.String xml, int startRow, int startCol)Inserts the XML data from the specified string into this ExcelWorksheet starting from thenStartRow
row index andnStartCol
column index
This method is overridden as easy_insertXMLFromString_2 in COM+ version of EasyXLS.
- Parameters:
xml
- the string in XML formatstartRow
- the index of the row that the XML data will be inserted fromstartCol
- the index of the column that the XML data will be inserted from
-
easy_insertXMLFromString
public 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.
- Parameters:
xml
- the string in XML formatstartCellReference
- the cell where the XML data will be inserted from
-
easy_addArrayFormula
public void easy_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 array; it should start with = (an equal sign) and it can be any kind of formula recognized by Excel- See Also:
easy_addArrayFormula(int,int,int,int,String)
-
easy_addArrayFormula
public 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.
- Parameters:
startRow
- the first row of the range where the array formula is enteredstartColumn
- the first column of the range where the array formula is enteredendRow
- the last row of the range where the array formula is enteredendColumn
- the last column of the range where the array formula is enteredsFormula
- the formula of the array; it should start with = (an equal sign) and it can be any kind of formula recognized by Excel- See Also:
easy_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
-
easy_removeArrayFormula
public void easy_removeArrayFormula(int index)Removes the array formula from the specified index.- Parameters:
index
- the index of the array formula to remove- See Also:
easy_removeArrayFormula(String)
,easy_removeArrayFormula(int, int, int, int)
-
easy_removeArrayFormula
public 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.
- Parameters:
s2DRangeReference
- the location where the array formula is entered. It can only be a range of cells (e.g. A1:B2).- See Also:
easy_removeArrayFormula(int, int, int, int)
,easy_removeArrayFormula(int)
-
easy_removeArrayFormula
public 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.
- Parameters:
startRow
- the first row of the range where the array formula is enteredstartColumn
- the first column of the range where the array formula is enteredendRow
- the last row of the range where the array formula is enteredendColumn
- the last column of the range where the array formula is entered- See Also:
easy_removeArrayFormula(int)
-
easy_getArrayFormulaAt
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 formulanColumn
- 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.
-
easy_getArrayFormulaAt
Returns the array formula located at the specified range.
This method is overridden as easy_getArrayFormulaAt_2 in COM+ version of EasyXLS.
- 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.
-
easy_getArrayFormulaAt
Returns the array formula from the specified index.
This method is overridden as easy_getArrayFormulaAt_3 in COM+ version of EasyXLS.
- Parameters:
index
- the index of the array formula to return- Returns:
- the array formula from the specified index
-
easy_addName
Adds the specified name to worksheet.- Parameters:
xlsName
- the name to be added- See Also:
easy_addName(String,String)
,easy_removeName(int)
,easy_removeName(String)
,easy_getNameAt(int)
,easy_getName(System.String)
,NameCount()
-
easy_addName
public 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.
- Parameters:
sNameText
- the title of the namesRefersTo
- the formula of the name; should start with = (an equal sign) and can be any kind of formula recognized by Excel- See Also:
easy_addName(ExcelName)
,easy_removeName(int)
,easy_removeName(String)
,easy_getNameAt(int)
,easy_getName(System.String)
,NameCount()
-
easy_removeName
public void easy_removeName(int index)Removes the name from the specified index.- Parameters:
index
- the index of the name to remove- See Also:
easy_addName(ExcelName)
,easy_addName(String,String)
,easy_removeName(String)
,easy_getNameAt(int)
,easy_getName(System.String)
,NameCount()
-
easy_removeName
public void easy_removeName(System.String sNameText)Removes the name having the specified title.- Parameters:
sNameText
- the title of the name- See Also:
easy_addName(ExcelName)
,easy_addName(String,String)
,easy_removeName(int)
,easy_getNameAt(int)
,easy_getName(System.String)
,NameCount()
-
easy_getNameAt
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:
easy_addName(ExcelName)
,easy_addName(String,String)
,easy_removeName(int)
,easy_removeName(String)
,easy_getName(System.String)
,NameCount()
-
easy_getName
Returns the name having the specified title.- Parameters:
sNameText
- the title of the name- Returns:
- the name from the specified title
- See Also:
easy_addName(ExcelName)
,easy_addName(String,String)
,easy_removeName(int)
,easy_removeName(String)
,easy_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:
easy_addName(ExcelName)
,easy_addName(String,String)
,easy_removeName(int)
,easy_removeName(String)
,easy_getNameAt(int)
,easy_getName(System.String)
,NameCount()
-
easy_getPageSetup
Returns the page setup options for the worksheet.- Returns:
- the page setup options for the worksheet
-
easy_addDataValidator
Adds the specified data validator to worksheet.- Parameters:
xlsValidator
- the data validator to be added- See Also:
easy_addDataValidator(String,int,int,String,String)
,easy_addDataValidator(int,int,int,int,int,int,String,String)
,easy_removeDataValidator(int)
,easy_removeDataValidator(String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
,DataValidatorCount()
-
easy_addDataValidator
public 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.
- Parameters:
firstRow
- the first row of the cell range where the validation will be appliedfirstColumn
- the first column of the cell range where the validation will be appliedlastRow
- the last row of the cell range where the validation will be appliedlastColumn
- the last column of the cell range where the validation will be appliedoperatorType
- the operator type. Possible values are available inDataValidator
class.validationType
- the validation type. Possible values are available inDataValidator
class.firstFormula
- the expression of the first formulasecondFormula
- the expression of the second formula- See Also:
easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_removeDataValidator(int)
,easy_removeDataValidator(String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
,DataValidatorCount()
-
easy_addDataValidator
public 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.
- 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 inDataValidator
class.validationType
- the validation type. Possible values are available inDataValidator
class.firstFormula
- the expression of the first formulasecondFormula
- the expression of the second formula- See Also:
easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(int,int,int,int,int,int,String,String)
,easy_removeDataValidator(int)
,easy_removeDataValidator(String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
,DataValidatorCount()
-
easy_removeDataValidator
public void easy_removeDataValidator(int index)Removes the data validator from the specified index.- Parameters:
index
- the index of the data validator to remove- See Also:
easy_removeDataValidator(String)
,easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
,DataValidatorCount()
-
easy_removeDataValidator
public 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.
- Parameters:
range
- the area location of the data validator. It can be a cell reference or a range.- See Also:
easy_removeDataValidator(int)
,easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
,DataValidatorCount()
-
easy_getDataValidatorAt
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:
easy_getDataValidatorAt(String)
,easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_removeDataValidator(int)
,easy_removeDataValidator(String)
,DataValidatorCount()
-
easy_getDataValidatorAt
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:
easy_getDataValidatorAt(int)
,easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_removeDataValidator(int)
,easy_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:
easy_addDataValidator(ExcelDataValidator)
,easy_addDataValidator(String,int,int,String,String)
,easy_removeDataValidator(int)
,easy_removeDataValidator(String)
,easy_getDataValidatorAt(int)
,easy_getDataValidatorAt(String)
-
easy_addHyperlink
Adds the specified hyperlink to worksheet.- Parameters:
xlsHyperlink
- the hyperlink to be added- See Also:
easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_addHyperlink
public 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.
- Parameters:
hyperlinkType
- the hyperlink type. Possible values are available inHyperlinkType
class.url
- the URL valueposition
- the area location of the hyperlink. It can be a cell reference or a range.- See Also:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_addHyperlink
public 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.
- Parameters:
hyperlinkType
- the hyperlink type. Possible values are available inHyperlinkType
class.url
- the URL valuetooltip
- the tool tip textposition
- the area location of the hyperlink. It can be a cell reference or a range.- See Also:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_removeHyperlink
public void easy_removeHyperlink(int index, bool clearCellValue)Removes the hyperlink from the specified index.- Parameters:
index
- the index of the Hyperlink to removeclearCellValue
- true if it clears the cell value, false otherwise- See Also:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_removeHyperlink
public 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.
- 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:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_getHyperlinkAt
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:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(String)
,HyperlinkCount()
-
easy_getHyperlinkAt
Returns the hyperlink from the specified index.
This method is overridden as easy_getHyperlinkAt_3 in COM+ version of EasyXLS.
- 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:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,HyperlinkCount()
-
easy_getHyperlinkAt
Returns the hyperlink at the specified row index and column index.
This method is overridden as easy_getHyperlinkAt_2 in COM+ version of EasyXLS.
- Parameters:
nRow
- the index of the rownColumn
- the index of the column- Returns:
- the hyperlink at the specified row index and column index.
- See Also:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_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:
easy_addHyperlink(ExcelHyperlink)
,easy_addHyperlink(String,String,String)
,easy_addHyperlink(String,String,String,String)
,easy_removeHyperlink(int,bool)
,easy_removeHyperlink(String,bool)
,easy_getHyperlinkAt(int)
,easy_getHyperlinkAt(String)
-
easy_addHeader
Adds the specified header to worksheet.- Parameters:
xlsHeader
- the header to be added- See Also:
easy_addHeader(String,String)
,easy_addHeader(String,String,String,int,bool,bool)
,easy_removeHeader(int)
,easy_removeHeader(String)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
,HeaderCount()
-
easy_addHeader
public 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.
- Parameters:
text
- the text from the headerposition
- the position of the header. Possible values are available inHeader
class.- See Also:
easy_addHeader(ExcelHeader)
,easy_addHeader(String,String,String,int,bool,bool)
,easy_removeHeader(int)
,easy_removeHeader(String)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
,HeaderCount()
-
easy_addHeader
public 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.
- Parameters:
text
- the text from the headerposition
- the position of the header. Possible values are available inHeader
class.fontName
- the font name of the headerfontSize
- the font size of the headerisBold
- the bold option of the headerisItalic
- the italic option of header- See Also:
easy_addHeader(ExcelHeader)
,easy_addHeader(String,String)
,easy_removeHeader(int)
,easy_removeHeader(String)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
,HeaderCount()
-
easy_removeHeader
public void easy_removeHeader(int index)Removes the header from the specified index.- Parameters:
index
- the index of the header to remove- See Also:
easy_removeHeader(String)
,easy_addHeader(ExcelHeader)
,easy_addHeader(String,String)
,easy_addHeader(String,String,String,int,bool,bool)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
,HeaderCount()
-
easy_removeHeader
public void easy_removeHeader(System.String position)Removes the header from the specified position.- Parameters:
position
- the position of the header. Possible values are available inHeader
class.- See Also:
easy_removeHeader(int)
,easy_addHeader(ExcelHeader)
,easy_addHeader(String,String)
,easy_addHeader(String,String,String,int,bool,bool)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
,HeaderCount()
-
easy_getHeaderAt
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:
easy_getHeaderAt(String)
,easy_addHeader(ExcelHeader)
,easy_addHeader(String,String)
,easy_addHeader(String,String,String,int,bool,bool)
,easy_removeHeader(int)
,easy_removeHeader(String)
,easy_removeHeader(int)
,HeaderCount()
-
easy_getHeaderAt
Returns the header from the specified position.- Parameters:
position
- the position of the header. Possible values are available inHeader
class.- Returns:
- the header from the specified position
- See Also:
easy_getHeaderAt(int)
,easy_addHeader(ExcelHeader)
,easy_addHeader(String, String)
,easy_removeHeader(int)
,easy_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:
easy_addHeader(ExcelHeader)
,easy_addHeader(String, String)
,easy_removeHeader(int)
,easy_removeHeader(String)
,easy_getHeaderAt(int)
,easy_getHeaderAt(String)
-
easy_addChart
Adds the specified chart to worksheet.- Parameters:
xlsChart
- the chart to be added- See Also:
easy_removeChart(int)
,easy_getChartAt(int)
,ChartCount()
-
easy_addChart
Adds a chart that has the specified location to worksheet.
This method is overridden as easy_addChart_2 in COM+ version of EasyXLS.
- Parameters:
xlsChart
- the chart to be addedrow
- the row number where the left upper corner of the chart is anchoredcolumn
- the column number where the left upper corner of the chart is anchored- See Also:
easy_removeChart(int)
,easy_getChartAt(int)
,ChartCount()
-
easy_addChart
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.
- Parameters:
xlsChart
- the chart to be addedrow
- the row number where the left upper corner of the chart is anchoredcolumn
- the column number where the left upper corner of the chart is anchoredwidth
- the chart widthheight
- the chart height- See Also:
easy_removeChart(int)
,easy_getChartAt(int)
,ChartCount()
-
easy_addChart
Adds a chart that has the specified location to worksheet.
This method is overridden as easy_addChart_4 in COM+ version of EasyXLS.
- Parameters:
xlsChart
- the chart to be addedposition
- the cell reference where the left upper corner of the chart is anchored- See Also:
easy_removeChart(int)
,easy_getChartAt(int)
,ChartCount()
-
easy_addChart
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.
- Parameters:
xlsChart
- the chart to be addedposition
- the cell reference where the left upper corner of the chart is anchoredwidth
- the chart widthheight
- the chart height- See Also:
easy_removeChart(int)
,easy_getChartAt(int)
,ChartCount()
-
easy_removeChart
public void easy_removeChart(int index)Removes the chart from the specified index.- Parameters:
index
- the index of the chart to remove- See Also:
easy_addChart(EasyXLS.Charts.ExcelChart)
,easy_getChartAt(int)
,ChartCount()
-
easy_getChartAt
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:
easy_addChart(EasyXLS.Charts.ExcelChart)
,easy_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:
easy_addChart(EasyXLS.Charts.ExcelChart)
,easy_removeChart(int)
,easy_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 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 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)
-
easy_addDataGroup
Adds the specified data group to worksheet.- Parameters:
xlsGroup
- the data group to be added- See Also:
easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_addDataGroup
public 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.
- 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 inDataGroup
class.isCollapsed
- true if the data group is collapsed, false if the data group is expanded- See Also:
easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_addDataGroup
public 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.
- Parameters:
firstRow
- first row index of the cells rangefirstColumn
- first column index of the cells rangelastRow
- last row index of the cells rangelastColumn
- last column index of the cells rangegroupRowsColumns
- the grouping per rows or columns option. Possible values are available inDataGroup
class.isCollapsed
- true if the data group is collapsed, false if the data group is expanded- See Also:
easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_addDataGroup
public 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.
- 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 inDataGroup
class.isCollapsed
- true if the data group is collapsed, false if the data group is expandedxlsAutoFormat
- the autoformat to be applied- See Also:
easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_addDataGroup
public 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.
- Parameters:
firstRow
- first row index of the cells rangefirstColumn
- first column index of the cells rangelastRow
- last row index of the cells rangelastColumn
- last column index of the cells rangegroupRowsColumns
- the grouping per rows or columns option. Possible values are available inDataGroup
class.isCollapsed
- true if the data group is collapsed, false if the data group is expandedxlsAutoFormat
- the autoformat to be applied- See Also:
easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_removeDataGroup
public void easy_removeDataGroup(int index)Removes the data group from the specified index.- Parameters:
index
- the index of the data group to remove- See Also:
easy_removeDataGroup(String)
,easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_removeDataGroup
public 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.
- Parameters:
range
- the area location of the data group. It can be a cell reference or a range.- See Also:
easy_removeDataGroup(int)
,easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
,DataGroupCount()
-
easy_getDataGroupAt
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:
easy_getDataGroupAt(String)
,easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,DataGroupCount()
-
easy_getDataGroupAt
Returns the data group from the specified range.
This method is overridden as easy_getDataGroupAt_2 in COM+ version of EasyXLS.
- 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:
easy_getDataGroupAt(int)
,easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_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:
easy_addDataGroup(ExcelDataGroup)
,easy_addDataGroup(String, int, bool)
,easy_addDataGroup(int, int, int, int, int, bool)
,easy_addDataGroup(String, int, bool, ExcelAutoFormat)
,easy_addDataGroup(int, int, int, int, int, bool, ExcelAutoFormat)
,easy_removeDataGroup(int)
,easy_removeDataGroup(String)
,easy_getDataGroupAt(int)
,easy_getDataGroupAt(String)
-
easy_addPivotTable
Adds a pivot table to the worksheet.- Parameters:
xlsPivotTable
- the pivot table to be added- See Also:
easy_addPivotTable(String,String,String,EasyXLS.ExcelDocument)
,easy_removePivotTable(int)
,easy_getPivotTableAt(int)
,PivotTableCount()
-
easy_addPivotTable
public 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.
- Parameters:
name
- the name of the pivot tablelocation
- the location of the pivot table. It must be a formula, that represents a range or a cell reference.sourceFormulaRange
- the data source for the pivot table. It must be a range including the sheet name (like Sheet1!A1:C10) or a named range.xls
- the instance of the document- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_removePivotTable(int)
,easy_getPivotTableAt(int)
,PivotTableCount()
-
easy_removePivotTable
public void easy_removePivotTable(int index)Removes the pivot table from the specified index.- Parameters:
index
- the index of the pivot table to remove- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_addPivotTable(String,String,String,EasyXLS.ExcelDocument)
,easy_getPivotTableAt(int)
,PivotTableCount()
-
easy_getPivotTableAt
Returns the pivot table from the specified index.- Parameters:
index
- the index of the pivot table to return- Returns:
- the pivot table from the specified index
- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_addPivotTable(String,String,String,EasyXLS.ExcelDocument)
,easy_removePivotTable(int)
,PivotTableCount()
-
easy_getPivotTable
Returns the pivot table having the specified name.- Parameters:
name
- the name of the pivot table to return- Returns:
- the pivot table having the specified name
- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_addPivotTable(String,String,String,EasyXLS.ExcelDocument)
,easy_removePivotTable(int)
,PivotTableCount()
-
PivotTableCount
public int PivotTableCount()Returns the number of pivot tables in the worksheet.- Returns:
- the number of pivot tables in the worksheet
- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_addPivotTable(String,String,String,EasyXLS.ExcelDocument)
,easy_removePivotTable(int)
,easy_getPivotTableAt(int)
-
easy_addPivotChart
Adds a pivot chart to the worksheet.- Parameters:
xlsPivotChart
- the pivot chart to be added- See Also:
easy_addPivotTable(ExcelPivotTable)
,easy_addChart(EasyXLS.Charts.ExcelChart)
,easy_getChartAt(int)
,ChartCount()
-
easy_getFilter
Returns the filter for the worksheet.- Returns:
- the filter for the worksheet
-
AllowSelectLockedCells
public bool AllowSelectLockedCells()Returns true if the selection of locked cells is allowed when the sheet is protected, false otherwise.- Returns:
- true if the selection of locked cells is allowed when the sheet is protected, false otherwise
- See Also:
setAllowSelectLockedCells(bool)
,setAllowSelectUnlockedCells(bool)
-
setAllowSelectLockedCells
public void setAllowSelectLockedCells(bool allow)Sets if the selection of locked cells is allowed when the sheet is protected.- Parameters:
allow
- true if the selection of locked cells is allowed when the sheet is protected, false otherwise- See Also:
AllowSelectLockedCells()
,AllowSelectUnlockedCells()
-
AllowSelectUnlockedCells
public bool AllowSelectUnlockedCells()Returns true if the selection of unlocked cells is allowed when the sheet is protected, false otherwise.- Returns:
- true if the selection of unlocked cells is allowed when the sheet is protected, false otherwise
- See Also:
setAllowSelectUnlockedCells(bool)
,setAllowSelectLockedCells(bool)
-
setAllowSelectUnlockedCells
public void setAllowSelectUnlockedCells(bool allow)Sets if the selection of unlocked cells is allowed when the sheet is protected.- Parameters:
allow
- true if the selection of unlocked cells is allowed when the sheet is protected, false otherwise- See Also:
AllowSelectUnlockedCells()
,AllowSelectLockedCells()
-
AllowFormatCells
public bool AllowFormatCells()Returns true if formatting cells is allowed when the sheet is protected, false otherwise.- Returns:
- true if formatting cells is allowed when the sheet is protected, false otherwise
- See Also:
setAllowFormatCells(bool)
,setAllowFormatColumns(bool)
,setAllowFormatRows(bool)
-
setAllowFormatCells
public void setAllowFormatCells(bool allow)Sets if formatting cells is allowed when the sheet is protected.- Parameters:
allow
- true if formatting cells is allowed when the sheet is protected, false otherwise- See Also:
AllowFormatCells()
,AllowFormatColumns()
,AllowFormatRows()
-
AllowFormatColumns
public bool AllowFormatColumns()Returns true if formatting columns is allowed when the sheet is protected, false otherwise.- Returns:
- true if formatting columns is allowed when the sheet is protected, false otherwise
- See Also:
setAllowFormatColumns(bool)
,setAllowFormatRows(bool)
,setAllowFormatCells(bool)
-
setAllowFormatColumns
public void setAllowFormatColumns(bool allow)Sets if formatting columns is allowed when the sheet is protected.- Parameters:
allow
- true if formatting columns is allowed when the sheet is protected, false otherwise- See Also:
AllowFormatColumns()
,AllowFormatRows()
,AllowFormatCells()
-
AllowFormatRows
public bool AllowFormatRows()Returns true if formatting rows is allowed when the sheet is protected, false otherwise.- Returns:
- true if formatting rows is allowed when the sheet is protected, false otherwise
- See Also:
setAllowFormatRows(bool)
,setAllowFormatColumns(bool)
,setAllowFormatCells(bool)
-
setAllowFormatRows
public void setAllowFormatRows(bool allow)Sets if formatting rows is allowed when the sheet is protected.- Parameters:
allow
- true if formatting rows is allowed when the sheet is protected, false otherwise- See Also:
AllowFormatRows()
,AllowFormatColumns()
,AllowFormatCells()
-
AllowInsertColumns
public bool AllowInsertColumns()Returns true if inserting columns is allowed when the sheet is protected, false otherwise.- Returns:
- true if inserting columns is allowed when the sheet is protected, false otherwise
- See Also:
setAllowInsertColumns(bool)
,setAllowInsertRows(bool)
-
setAllowInsertColumns
public void setAllowInsertColumns(bool allow)Sets if inserting columns is allowed when the sheet is protected.- Parameters:
allow
- true if inserting columns is allowed when the sheet is protected, false otherwise- See Also:
AllowInsertColumns()
,AllowInsertRows()
-
AllowInsertRows
public bool AllowInsertRows()Returns true if inserting rows is allowed when the sheet is protected, false otherwise.- Returns:
- true if inserting rows is allowed when the sheet is protected, false otherwise
- See Also:
setAllowInsertRows(bool)
,setAllowInsertColumns(bool)
-
setAllowInsertRows
public void setAllowInsertRows(bool allow)Sets if inserting rows is allowed when the sheet is protected.- Parameters:
allow
- true if inserting rows is allowed when the sheet is protected, false otherwise- See Also:
AllowInsertRows()
,AllowInsertColumns()
-
AllowInsertHyperlinks
public bool AllowInsertHyperlinks()Returns true if inserting hyperlinks is allowed when the sheet is protected, false otherwise.- Returns:
- true if inserting hyperlinks is allowed when the sheet is protected, false otherwise
- See Also:
setAllowInsertHyperlinks(bool)
-
setAllowInsertHyperlinks
public void setAllowInsertHyperlinks(bool allow)Sets if inserting hyperlinks is allowed when the sheet is protected.- Parameters:
allow
- true if inserting hyperlinks is allowed when the sheet is protected, false otherwise- See Also:
AllowInsertHyperlinks()
-
AllowDeleteColumns
public bool AllowDeleteColumns()Returns true if deleting columns is allowed when the sheet is protected, false otherwise.- Returns:
- true if deleting columns is allowed when the sheet is protected, false otherwise
- See Also:
setAllowDeleteColumns(bool)
,setAllowDeleteRows(bool)
-
setAllowDeleteColumns
public void setAllowDeleteColumns(bool allow)Sets if deleting columns is allowed when the sheet is protected.- Parameters:
allow
- true if deleting columns is allowed when the sheet is protected, false otherwise- See Also:
AllowDeleteColumns()
,AllowDeleteRows()
-
AllowDeleteRows
public bool AllowDeleteRows()Returns true if deleting rows is allowed when the sheet is protected, false otherwise.- Returns:
- true if deleting rows is allowed when the sheet is protected, false otherwise
- See Also:
setAllowDeleteRows(bool)
,setAllowDeleteColumns(bool)
-
setAllowDeleteRows
public void setAllowDeleteRows(bool allow)Sets if deleting rows is allowed when the sheet is protected.- Parameters:
allow
- true if deleting rows is allowed when the sheet is protected, false otherwise- See Also:
AllowDeleteRows()
,AllowDeleteColumns()
-
AllowSort
public bool AllowSort()Returns true if sorting is allowed when the sheet is protected, false otherwise.- Returns:
- true if sorting is allowed when the sheet is protected, false otherwise
- See Also:
setAllowSort(bool)
,setAllowUseAutofilter(bool)
-
setAllowSort
public void setAllowSort(bool allow)Sets if sorting is allowed when the sheet is protected.- Parameters:
allow
- true if sorting is allowed when the sheet is protected, false otherwise- See Also:
AllowSort()
,AllowUseAutofilter()
-
AllowUseAutofilter
public bool AllowUseAutofilter()Returns true if autofilter is allowed when the sheet is protected, false otherwise.- Returns:
- true if autofilter is allowed when the sheet is protected, false otherwise
- See Also:
setAllowUseAutofilter(bool)
,setAllowSort(bool)
-
setAllowUseAutofilter
public void setAllowUseAutofilter(bool allow)Sets if autofilter is allowed when the sheet is protected.- Parameters:
allow
- true if autofilter is allowed when the sheet is protected, false otherwise- See Also:
AllowUseAutofilter()
,AllowSort()
-
AllowUsePivots
public bool AllowUsePivots()Returns true if using pivot tables and pivot charts is allowed when the sheet is protected, false otherwise.- Returns:
- true if using pivot tables and pivot charts is allowed when the sheet is protected, false otherwise
- See Also:
setAllowUsePivots(bool)
-
setAllowUsePivots
public void setAllowUsePivots(bool allow)Sets if using pivot tables and pivot charts is allowed when the sheet is protected.- Parameters:
allow
- true if using pivot tables and pivot charts is allowed when the sheet is protected, false otherwise- See Also:
AllowUsePivots()
-
AllowEditObjects
public bool AllowEditObjects()Returns true if editing objects is allowed when the sheet is protected, false otherwise.- Returns:
- true if editing objects is allowed when the sheet is protected, false otherwise
- See Also:
setAllowEditObjects(bool)
,setAllowEditScenarios(bool)
-
setAllowEditObjects
public void setAllowEditObjects(bool allow)Sets if editing objects is allowed when the sheet is protected.- Parameters:
allow
- true if editing objects is allowed when the sheet is protected, false otherwise- See Also:
AllowEditObjects()
,AllowEditScenarios()
-
AllowEditScenarios
public bool AllowEditScenarios()Returns true if editing scenarios is allowed when the sheet is protected, false otherwise.- Returns:
- true if editing scenarios is allowed when the sheet is protected, false otherwise
- See Also:
setAllowEditScenarios(bool)
,setAllowEditObjects(bool)
-
setAllowEditScenarios
public void setAllowEditScenarios(bool allow)Sets if editing scenarios is allowed when the sheet is protected.- Parameters:
allow
- true if editing scenarios is allowed when the sheet is protected, false otherwise- See Also:
AllowEditScenarios()
,AllowEditObjects()
-
Dispose
public void Dispose()Disposes any resources that it has allocated.- Overrides:
Dispose
in classExcelSheet
-
Clone
Creates and returns a copy of this object.- Specified by:
Clone
in classExcelSheet
- Returns:
- a clone of this instance.
-
RestoreDefaults
public void RestoreDefaults()Internal use only- Overrides:
RestoreDefaults
in classEasyXLS.BIFF_Records.SheetStream
-