New in PyXLL 5.12
The @xl_event decorators are used to register Python functions that will be called when specific
Excel Application events occur.
The events that can be handled are the same as the Excel Application events available through VBA, and the Python functions have the same arguments as their VBA counterparts.
For more detailed information please see Excel Application Events in the user guide.
Registers an Excel Application event handler.
This is the generic decorator that can be used for all event types.
Specific helper decorators are provided that can be used instead of this, and those are listed below.
Example:
from pyxll import xl_event
@xl_event("AfterCalculate")
def on_after_calculate():
print("AfterCalculate fired")
event – Excel Application event name, as it is defined in VBA.
com_package –
The COM package to use when passing COM arguments to the Python event hander.
Can be either pywin32 or comtypes.
If not specified, the default can be specified using the com_package setting in
the [PYXLL]] section of the pyxll.cfg config file. pywin32 is used if no
other default is specified.
filter –
Function to call prior to the event handler to test if the handler should be called or not.
The filter function should have the same signature as the event handler.
Registers a NewWorkbook event handler. Example usage:
from pyxll import xl_event
@xl_event.new_workbook
def on_new_workbook(workbook: object):
print("NewWorkbook fired")
Equivalent to @xl_event("NewWorkbook").
Registers a SheetSelectionChange event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_selection_change
def on_sheet_selection_change(sheet: object, target: object):
print("SheetSelectionChange fired")
Equivalent to @xl_event("SheetSelectionChange").
Registers a SheetBeforeDoubleClick event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_before_double_click
def on_sheet_before_double_click(sheet: object, target: object, cancel: bool):
print("SheetBeforeDoubleClick fired")
Equivalent to @xl_event("SheetBeforeDoubleClick").
Registers a SheetBeforeRightClick event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_before_right_click
def on_sheet_before_right_click(sheet: object, target: object, cancel: bool):
print("SheetBeforeRightClick fired")
Equivalent to @xl_event("SheetBeforeRightClick").
Registers a SheetActivate event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_activate
def on_sheet_activate(sheet: object):
print("SheetActivate fired")
Equivalent to @xl_event("SheetActivate").
Registers a SheetDeactivate event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_deactivate
def on_sheet_deactivate(sheet: object):
print("SheetDeactivate fired")
Equivalent to @xl_event("SheetDeactivate").
Registers a SheetCalculate event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_calculate
def on_sheet_calculate(sheet: object):
print("SheetCalculate fired")
Equivalent to @xl_event("SheetCalculate").
Registers a SheetChange event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_change
def on_sheet_change(sheet: object, target: object):
print("SheetChange fired")
Equivalent to @xl_event("SheetChange").
Registers a WorkbookOpen event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_open
def on_workbook_open(workbook: object):
print("WorkbookOpen fired")
Equivalent to @xl_event("WorkbookOpen").
Registers a WorkbookActivate event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_activate
def on_workbook_activate(workbook: object):
print("WorkbookActivate fired")
Equivalent to @xl_event("WorkbookActivate").
Registers a WorkbookDeactivate event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_deactivate
def on_workbook_deactivate(workbook: object):
print("WorkbookDeactivate fired")
Equivalent to @xl_event("WorkbookDeactivate").
Registers a WorkbookBeforeClose event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_before_close
def on_workbook_before_close(workbook: object, cancel: bool):
print("WorkbookBeforeClose fired")
Equivalent to @xl_event("WorkbookBeforeClose").
Registers a WorkbookBeforeSave event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_before_save
def on_workbook_before_save(workbook: object, save_as_ui: bool, cancel: bool):
print("WorkbookBeforeSave fired")
Equivalent to @xl_event("WorkbookBeforeSave").
Registers a WorkbookBeforePrint event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_before_print
def on_workbook_before_print(workbook: object, cancel: bool):
print("WorkbookBeforePrint fired")
Equivalent to @xl_event("WorkbookBeforePrint").
Registers a WorkbookNewSheet event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_new_sheet
def on_workbook_new_sheet(workbook: object, sheet: object):
print("WorkbookNewSheet fired")
Equivalent to @xl_event("WorkbookNewSheet").
Registers a WorkbookAddinInstall event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_addin_install
def on_workbook_addin_install(workbook: object):
print("WorkbookAddinInstall fired")
Equivalent to @xl_event("WorkbookAddinInstall").
Registers a WorkbookAddinUninstall event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_addin_uninstall
def on_workbook_addin_uninstall(workbook: object):
print("WorkbookAddinUninstall fired")
Equivalent to @xl_event("WorkbookAddinUninstall").
Registers a WindowResize event handler. Example usage:
from pyxll import xl_event
@xl_event.window_resize
def on_window_resize(workbook: object, wn: object):
print("WindowResize fired")
Equivalent to @xl_event("WindowResize").
Registers a WindowActivate event handler. Example usage:
from pyxll import xl_event
@xl_event.window_activate
def on_window_activate(workbook: object, wn: object):
print("WindowActivate fired")
Equivalent to @xl_event("WindowActivate").
Registers a WindowDeactivate event handler. Example usage:
from pyxll import xl_event
@xl_event.window_deactivate
def on_window_deactivate(workbook: object, wn: object):
print("WindowDeactivate fired")
Equivalent to @xl_event("WindowDeactivate").
Registers a SheetFollowHyperlink event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_follow_hyperlink
def on_sheet_follow_hyperlink(sheet: object, target: str):
print("SheetFollowHyperlink fired")
Equivalent to @xl_event("SheetFollowHyperlink").
Registers a SheetPivotTableUpdate event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_pivot_table_update
def on_sheet_pivot_table_update(sheet: object, target: object):
print("SheetPivotTableUpdate fired")
Equivalent to @xl_event("SheetPivotTableUpdate").
Registers a WorkbookPivotTableCloseConnection event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_pivot_table_close_connection
def on_workbook_pivot_table_close_connection(workbook: object, target: object):
print("WorkbookPivotTableCloseConnection fired")
Equivalent to @xl_event("WorkbookPivotTableCloseConnection").
Registers a WorkbookPivotTableOpenConnection event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_pivot_table_open_connection
def on_workbook_pivot_table_open_connection(workbook: object, target: object):
print("WorkbookPivotTableOpenConnection fired")
Equivalent to @xl_event("WorkbookPivotTableOpenConnection").
Registers a WorkbookSync event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_sync
def on_workbook_sync(workbook: object, sync_event_type: int):
print("WorkbookSync fired")
Equivalent to @xl_event("WorkbookSync").
Registers a WorkbookBeforeXmlImport event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_before_xml_import
def on_workbook_before_xml_import(workbook: object, xml_map: object, url: str, is_refresh: bool, cancel: bool):
print("WorkbookBeforeXmlImport fired")
Equivalent to @xl_event("WorkbookBeforeXmlImport").
Registers a WorkbookAfterXmlImport event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_after_xml_import
def on_workbook_after_xml_import(workbook: object, xml_map: object, is_refresh: bool, result: object):
print("WorkbookAfterXmlImport fired")
Equivalent to @xl_event("WorkbookAfterXmlImport").
Registers a WorkbookBeforeXmlExport event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_before_xml_export
def on_workbook_before_xml_export(workbook: object, xml_map: object, url: str, cancel: bool):
print("WorkbookBeforeXmlExport fired")
Equivalent to @xl_event("WorkbookBeforeXmlExport").
Registers a WorkbookAfterXmlExport event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_after_xml_export
def on_workbook_after_xml_export(workbook: object, xml_map: object, url: str, result: object):
print("WorkbookAfterXmlExport fired")
Equivalent to @xl_event("WorkbookAfterXmlExport").
Registers a WorkbookRowsetComplete event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_rowset_complete
def on_workbook_rowset_complete(workbook: object, description: str, sheet: str, success: bool):
print("WorkbookRowsetComplete fired")
Equivalent to @xl_event("WorkbookRowsetComplete").
Registers a AfterCalculate event handler. Example usage:
from pyxll import xl_event
@xl_event.after_calculate
def on_after_calculate():
print("AfterCalculate fired")
Equivalent to @xl_event("AfterCalculate").
Registers a SheetPivotTableAfterValueChange event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_pivot_table_after_value_change
def on_sheet_pivot_table_after_value_change(sheet: object, target_pivot_table: object, target_range: object):
print("SheetPivotTableAfterValueChange fired")
Equivalent to @xl_event("SheetPivotTableAfterValueChange").
Registers a SheetPivotTableBeforeAllocateChanges event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_pivot_table_before_allocate_changes
def on_sheet_pivot_table_before_allocate_changes(sheet: object, target_pivot_table: object, value_change_start: int, value_change_end: int, cancel: bool):
print("SheetPivotTableBeforeAllocateChanges fired")
Equivalent to @xl_event("SheetPivotTableBeforeAllocateChanges").
Registers a SheetPivotTableBeforeCommitChanges event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_pivot_table_before_commit_changes
def on_sheet_pivot_table_before_commit_changes(sheet: object, target_pivot_table: object, value_change_start: int, value_change_end: int, cancel: bool):
print("SheetPivotTableBeforeCommitChanges fired")
Equivalent to @xl_event("SheetPivotTableBeforeCommitChanges").
Registers a SheetPivotTableBeforeDiscardChanges event handler. Example usage:
from pyxll import xl_event
@xl_event.sheet_pivot_table_before_discard_changes
def on_sheet_pivot_table_before_discard_changes(sheet: object, target_pivot_table: object, value_change_start: int, value_change_end: int):
print("SheetPivotTableBeforeDiscardChanges fired")
Equivalent to @xl_event("SheetPivotTableBeforeDiscardChanges").
Registers a ProtectedViewWindowOpen event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_open
def on_protected_view_window_open(window: object):
print("ProtectedViewWindowOpen fired")
Equivalent to @xl_event("ProtectedViewWindowOpen").
Registers a ProtectedViewWindowBeforeEdit event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_before_edit
def on_protected_view_window_before_edit(window: object, cancel: bool):
print("ProtectedViewWindowBeforeEdit fired")
Equivalent to @xl_event("ProtectedViewWindowBeforeEdit").
Registers a ProtectedViewWindowBeforeClose event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_before_close
def on_protected_view_window_before_close(window: object, reason: int, cancel: bool):
print("ProtectedViewWindowBeforeClose fired")
Equivalent to @xl_event("ProtectedViewWindowBeforeClose").
Registers a ProtectedViewWindowResize event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_resize
def on_protected_view_window_resize(window: object):
print("ProtectedViewWindowResize fired")
Equivalent to @xl_event("ProtectedViewWindowResize").
Registers a ProtectedViewWindowActivate event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_activate
def on_protected_view_window_activate(window: object):
print("ProtectedViewWindowActivate fired")
Equivalent to @xl_event("ProtectedViewWindowActivate").
Registers a ProtectedViewWindowDeactivate event handler. Example usage:
from pyxll import xl_event
@xl_event.protected_view_window_deactivate
def on_protected_view_window_deactivate(window: object):
print("ProtectedViewWindowDeactivate fired")
Equivalent to @xl_event("ProtectedViewWindowDeactivate").
Registers a WorkbookAfterSave event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_after_save
def on_workbook_after_save(workbook: object, success: bool):
print("WorkbookAfterSave fired")
Equivalent to @xl_event("WorkbookAfterSave").
Registers a WorkbookNewChart event handler. Example usage:
from pyxll import xl_event
@xl_event.workbook_new_chart
def on_workbook_new_chart(workbook: object, chart: object):
print("WorkbookNewChart fired")
Equivalent to @xl_event("WorkbookNewChart").
