Cells class

Cells class

Encapsulates a collection of cell relevant objects, such as Cell, Row, …etc.

The Cells type exposes the following members:

Properties

PropertyDescription
ods_cell_fieldsGets the list of fields of ods.
countGets the total count of instantiated Cell objects.
count_largeGets the total count of instantiated Cell objects.
rowsGets the collection of Row objects that represents the individual rows in this worksheet.
merged_cellsGets the collection of merged cells.
multi_thread_readingGets or sets whether the cells data model should support Multi-Thread reading.
Default value of this property is false.
memory_settingGets or sets the memory usage option for this cells.
styleGets and sets the default style of the worksheet.
standard_width_inchGets or sets the default column width in the worksheet, in unit of inches.
standard_width_pixelsGets or sets the default column width in the worksheet, in unit of pixels.
standard_widthGets or sets the default column width in the worksheet, in unit of characters.
standard_heightGets or sets the default row height in this worksheet, in unit of points.
standard_height_pixelsGets or sets the default row height in this worksheet, in unit of pixels.
standard_height_inchGets or sets the default row height in this worksheet, in unit of inches.
preserve_stringGets or sets a value indicating whether all worksheet values are preserved as strings.
Default is false.
min_rowMinimum row index of cell which contains data or style.
max_rowMaximum row index of cell which contains data or style.
min_columnMinimum column index of those cells that have been instantiated in the collection(does not include the column
where style is defined for the whole column but no cell has been instantiated in it).
max_columnMaximum column index of those cells that have been instantiated in the collection(does not include the column
where style is defined for the whole column but no cell has been instantiated in it).
min_data_rowMinimum row index of cell which contains data.
max_data_rowMaximum row index of cell which contains data.
min_data_columnMinimum column index of cell which contains data.
max_data_columnMaximum column index of cell which contains data.
is_default_row_height_matchedIndicates that row height and default font height matches
is_default_row_hiddenIndicates whether the row is default hidden.
columnsGets the collection of Column objects that represents the individual columns in this worksheet.
rangesGets the collection of Range objects created at run time.
last_cellGets the last cell in this worksheet.
max_display_rangeGets the max range which includes data, merged cells and shapes.
first_cellGets the first cell in this worksheet.

Methods

MethodDescription
create_rangeCreates a Range object from a range of cells.
create_rangeCreates a Range object from a range of cells.
create_rangeCreates a Range object from an address of the range.
create_rangeCreates a Range object from rows of cells or columns of cells.
getAdd API for Python Via .Net.since this[int row, int column] is unsupported
getAdd API for Python Via .Net.since this[string cellName] is unsupported
import_object_arrayImports an array of data into a worksheet.
import_object_arrayImports an array of data into a worksheet.
import_arrayImports an array of string into a worksheet.
import_arrayImports an array of integer into a worksheet.
import_arrayImports an array of double into a worksheet.
import_csvImport a CSV file to the cells.
import_csvImport a CSV file to the cells.
import_csvImport a CSV file to the cells.
import_csvImport a CSV file to the cells.
mergeMerges a specified range of cells into a single cell.
mergeMerges a specified range of cells into a single cell.
mergeMerges a specified range of cells into a single cell.
get_column_width_pixelGets the width of the specified column in normal view, in units of pixel.
get_column_width_pixelGets the width of the specified column in normal view, in units of pixel.
copy_columnsCopies data and formats of a whole column.
copy_columnsCopies data and formats of a whole column.
copy_columnsCopies data and formats of the whole columns.
copy_rowsCopies data and formats of some whole rows.
copy_rowsCopies data and formats of some whole rows.
copy_rowsCopies data and formats of some whole rows.
group_columnsGroups columns.
group_columnsGroups columns.
ungroup_rowsUngroups rows.
ungroup_rowsUngroups rows.
group_rowsGroups rows.
group_rowsGroups rows.
delete_columnDeletes a column.
delete_columnDeletes a column.
delete_rowDeletes a row.
delete_rowDeletes a row.
delete_rowsDeletes several rows.
delete_rowsDeletes multiple rows in the worksheet.
delete_blank_columnsDelete all blank columns which do not contain any data.
delete_blank_columnsDelete all blank columns which do not contain any data.
delete_blank_rowsDelete all blank rows which do not contain any data or other object.
delete_blank_rowsDelete all blank rows which do not contain any data or other object.
insert_columnsInserts some columns into the worksheet.
insert_columnsInserts some columns into the worksheet.
insert_columnInserts a new column into the worksheet.
insert_columnInserts a new column into the worksheet.
insert_rowsInserts multiple rows into the worksheet.
insert_rowsInserts multiple rows into the worksheet.
insert_rowsInserts multiple rows into the worksheet.
clear_rangeClears contents and formatting of a range.
clear_rangeClears contents and formatting of a range.
clear_contentsClears contents of a range.
clear_contentsClears contents of a range.
clear_formatsClears formatting of a range.
clear_formatsClears formatting of a range.
findFinds the cell containing with the input object.
findFinds the cell containing with the input object.
end_cell_in_rowGets the last cell in this row.
end_cell_in_rowGets the last cell with maximum row index in this range.
end_cell_in_columnGets the last cell in this column.
end_cell_in_columnGets the last cell with maximum column index in this range.
insert_rangeInserts a range of cells and shift cells according to the shift option.
insert_rangeInserts a range of cells and shift cells according to the shift option.
insert_rangeInserts a range of cells and shift cells according to the shift option.
import_custom_objectsImports custom objects.
import_custom_objectsImports custom objects.
subtotalCreates subtotals for the range.
subtotalCreates subtotals for the range.
remove_duplicatesRemoves duplicate rows in the sheet.
remove_duplicatesRemoves duplicate values in the range.
remove_duplicatesRemoves duplicate data of the range.
get_row_enumeratorGets the rows enumerator.
get_merged_areasGets all merged cells.
get_cellGets the Cell element or null at the specified cell row index and column index.
get_rowGets the Row element at the specified cell row index.
check_cellGets the Cell element or null at the specified cell row index and column index.
check_rowGets the Row element or null at the specified cell row index.
check_columnGets the Column element or null at the specified column index.
is_row_hiddenChecks whether a row at given index is hidden.
is_column_hiddenChecks whether a column at given index is hidden.
add_rangeAdds a range object reference to cells
clearClears all data of the worksheet.
import_dataImport data from custom data table.
import_array_listImports an arraylist of data into a worksheet.
import_formula_arrayImports an array of formula into a worksheet.
text_to_columnsSplits the text in the column to columns.
un_mergeUnmerges a specified range of merged cells.
clear_merged_cellsClears all merged ranges.
hide_rowHides a row.
unhide_rowUnhides a row.
hide_rowsHides multiple rows.
unhide_rowsUnhides the hidden rows.
set_row_height_pixelSets row height in unit of pixels.
set_row_height_inchSets row height in unit of inches.
set_row_heightSets the height of the specified row.
get_row_original_height_pointGets original row’s height in unit of point if the row is hidden
get_column_original_width_pointGets original column’s height in unit of point if the column is hidden
hide_columnHides a column.
unhide_columnUnhides a column
hide_columnsHide multiple columns.
unhide_columnsUnhide multiple columns.
get_row_heightGets the height of a specified row, in unit of points.
get_view_row_heightGets the height of a specified row.
get_row_height_pixelGets the height of a specified row in unit of pixel.
get_row_height_inchGets the height of a specified row in unit of inches.
get_view_row_height_inchGets the height of a specified row in unit of inches.
set_column_width_pixelSets column width in unit of pixels in normal view.
set_column_width_inchSets column width in unit of inches in normal view.
set_column_widthSets the width of the specified column in normal view.
get_column_width_inchGets the width of the specified column in normal view, in units of inches.
get_column_widthGets the width(in unit of characters) of the specified column in normal view
get_view_column_width_pixelGet the width in different view type.
set_view_column_width_pixelSets the width of the column in different view.
get_last_data_rowGets the last row index of cell which contains data in the specified column.
apply_column_styleApplies formats for a whole column.
apply_row_styleApplies formats for a whole row.
apply_styleApplies formats for a whole worksheet.
copy_columnCopies data and formats of a whole column.
copy_rowCopies data and formats of a whole row.
get_grouped_row_outline_levelGets the outline level (zero-based) of the row.
get_grouped_column_outline_levelGets the outline level (zero-based) of the column.
get_max_grouped_column_outline_levelGets the max grouped column outline level (zero-based).
get_max_grouped_row_outline_levelGets the max grouped row outline level (zero-based).
show_group_detailExpands the grouped rows/columns.
hide_group_detailCollapses the grouped rows/columns.
ungroup_columnsUngroups columns.
delete_columnsDeletes several columns.
is_deleting_range_enabledCheck whether the range could be deleted.
is_blank_columnChecks whether given column is blank(does not contain any data).
insert_rowInserts a new row into the worksheet.
link_to_xml_mapLink to a xml map.
move_rangeMoves the range.
insert_cut_cellsInsert cut range.
delete_rangeDeletes a range of cells and shift cells according to the shift option.
retrieve_subtotal_settingRetrieves subtotals setting of the range.
remove_formulasRemoves all formula and replaces with the value of the formula.
convert_string_to_numeric_valueConverts all string data in the worksheet to numeric value if possible.
get_dependentsGet all cells which refer to the specific cell.
get_dependents_in_calculationGets all cells whose calculated result depends on specific cell.
get_cell_styleGet the style of given cell.

Remarks

See Also