phoenix_title wx.lib.agw.xlsgrid.Excel

A simple class that holds a COM interface to Excel.

By using the win32com module from Mark Hammonds’ pywin32 package, we can manipulate various workbook/worksheet methods inside this class.


class_hierarchy Class Hierarchy

Inheritance diagram for class Excel:

method_summary Methods Summary

__init__

Default class constructor.

Close

Closes the Excel workbook, interrupting the COM interface.

GetCommentsRange

Returns a range of cells containing comments, using the VBA API.

GetText

Returns the WYSIWYG text contained in a cell.


api Class API

class Excel(object)

A simple class that holds a COM interface to Excel.

By using the win32com module from Mark Hammonds’ pywin32 package, we can manipulate various workbook/worksheet methods inside this class.


Methods

__init__(self, filename, sheetname)

Default class constructor.

Parameters:
  • filename – a valid Excel xls filename;

  • sheetname – the worksheet name inside the Excel file (i.e., the label on the workbook tab at the bottom of the workbook).



Close(self, save=False)

Closes the Excel workbook, interrupting the COM interface.

Parameters:

saveTrue to save the changes you made to the workbook, False otherwise.



GetCommentsRange(self)

Returns a range of cells containing comments, using the VBA API.



GetText(self, row, col)

Returns the WYSIWYG text contained in a cell.

Parameters:
  • row – the row in which the cell lives;

  • col – the column in which the cell lives.

Note

The row and col parameters are not real Python index, as they use the Excel indexing mode (i.e., first index is 1 and not 0).