Language:

The Free and Open Productivity Suite
Apache OpenOffice 4.1.4 released

Developer's Guide

API

SDK

Tips 'n' Tricks

Miscellaneous


:: com :: sun :: star :: script :: vba ::

unpublished constants group VBAEventId
Usage Restrictions
not published
Description
Constants used to identify VBA document events.

If one of these events is fired, a specific VBA macro in a specific document code module will be executed.

Each event expects some specific arguments to be passed to XVBAEventProcessor::processVbaEvent.

See also
XVBAEventProcessor

Constants
NO_EVENT An identifier not corresponding to any VBA document event.  
AUTO_NEW New document opened from template. No arguments.  
AUTO_OPEN Document opened (loaded). No arguments.  
AUTO_CLOSE Document about to be closed. No arguments.  
AUTO_EXEC Application start. No arguments.  
AUTO_EXIT Application exit. No arguments.  
DOCUMENT_NEW New text document opened from template. No arguments.  
DOCUMENT_OPEN Text document opened (loaded). No arguments.  
DOCUMENT_CLOSE Document about to be closed. No arguments.  
WORKBOOK_ACTIVATE Document activated. No arguments.  
WORKBOOK_DEACTIVATE Document deactivated. No arguments.  
WORKBOOK_OPEN Document opened (loaded). No arguments.  
WORKBOOK_BEFORECLOSE Document about to be closed. Arguments: [out] boolean bCancel.  
WORKBOOK_BEFOREPRINT Document about to be printed. Arguments: [out] boolean bCancel.  
WORKBOOK_BEFORESAVE Document about to be saved. Arguments: boolean bSaveAs, [out] boolean bCancel.  
WORKBOOK_AFTERSAVE Document has been saved. Arguments: boolean bSuccess.  
WORKBOOK_NEWSHEET New sheet inserted. Arguments: short nSheet.  
WORKBOOK_WINDOWACTIVATE Document window has been activated. Arguments: XController aController.  
WORKBOOK_WINDOWDEACTIVATE Document window has been deactivated. Arguments: XController aController.  
WORKBOOK_WINDOWRESIZE Document window has been resized. Arguments: XController aController.  
WORKSHEET_ACTIVATE Worksheet has been activated (made visible). Arguments: short nSheet.  
WORKSHEET_DEACTIVATE Worksheet has been activated (made visible). Arguments: short nSheet.  
WORKSHEET_BEFOREDOUBLECLICK Double click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel.  
WORKSHEET_BEFORERIGHTCLICK Right click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel.  
WORKSHEET_CALCULATE Cells in sheet have been recalculated. Arguments: short nSheet.  
WORKSHEET_CHANGE Cells in sheet have been changed. Arguments: XRange/XSheetCellRangeContainer aRange.  
WORKSHEET_SELECTIONCHANGE Selection in sheet has been changed. Arguments: XRange/XSheetCellRangeContainer aRange.  
WORKSHEET_FOLLOWHYPERLINK Hyperlink has been clicked. Arguments: XCell aCell.  
USERDEFINED_START Implementations are allowed to use identifiers above this value for any internal purpose.  
Constants' Details
NO_EVENT
const long NO_EVENT = -1;
Description
An identifier not corresponding to any VBA document event.
AUTO_NEW
const long AUTO_NEW = 1;
Description
New document opened from template. No arguments.
AUTO_OPEN
const long AUTO_OPEN = 2;
Description
Document opened (loaded). No arguments.
AUTO_CLOSE
const long AUTO_CLOSE = 3;
Description
Document about to be closed. No arguments.
AUTO_EXEC
const long AUTO_EXEC = 4;
Description
Application start. No arguments.
AUTO_EXIT
const long AUTO_EXIT = 5;
Description
Application exit. No arguments.
DOCUMENT_NEW
const long DOCUMENT_NEW = 1001;
Description
New text document opened from template. No arguments.
DOCUMENT_OPEN
const long DOCUMENT_OPEN = 1002;
Description
Text document opened (loaded). No arguments.
DOCUMENT_CLOSE
const long DOCUMENT_CLOSE = 1003;
Description
Document about to be closed. No arguments.
WORKBOOK_ACTIVATE
const long WORKBOOK_ACTIVATE = 2001;
Description
Document activated. No arguments.
WORKBOOK_DEACTIVATE
const long WORKBOOK_DEACTIVATE = 2002;
Description
Document deactivated. No arguments.
WORKBOOK_OPEN
const long WORKBOOK_OPEN = 2003;
Description
Document opened (loaded). No arguments.
WORKBOOK_BEFORECLOSE
const long WORKBOOK_BEFORECLOSE = 2004;
Description
Document about to be closed. Arguments: [out] boolean bCancel.
WORKBOOK_BEFOREPRINT
const long WORKBOOK_BEFOREPRINT = 2005;
Description
Document about to be printed. Arguments: [out] boolean bCancel.
WORKBOOK_BEFORESAVE
const long WORKBOOK_BEFORESAVE = 2006;
Description
Document about to be saved. Arguments: boolean bSaveAs, [out] boolean bCancel.
WORKBOOK_AFTERSAVE
const long WORKBOOK_AFTERSAVE = 2007;
Description
Document has been saved. Arguments: boolean bSuccess.
WORKBOOK_NEWSHEET
const long WORKBOOK_NEWSHEET = 2008;
Description
New sheet inserted. Arguments: short nSheet.
WORKBOOK_WINDOWACTIVATE
const long WORKBOOK_WINDOWACTIVATE = 2009;
Description
Document window has been activated. Arguments: XController aController.
WORKBOOK_WINDOWDEACTIVATE
const long WORKBOOK_WINDOWDEACTIVATE = 2010;
Description
Document window has been deactivated. Arguments: XController aController.
WORKBOOK_WINDOWRESIZE
const long WORKBOOK_WINDOWRESIZE = 2011;
Description
Document window has been resized. Arguments: XController aController.
WORKSHEET_ACTIVATE
const long WORKSHEET_ACTIVATE = 2101;
Description
Worksheet has been activated (made visible). Arguments: short nSheet.
WORKSHEET_DEACTIVATE
const long WORKSHEET_DEACTIVATE = 2102;
Description
Worksheet has been activated (made visible). Arguments: short nSheet.
WORKSHEET_BEFOREDOUBLECLICK
const long WORKSHEET_BEFOREDOUBLECLICK = 2103;
Description
Double click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel.
WORKSHEET_BEFORERIGHTCLICK
const long WORKSHEET_BEFORERIGHTCLICK = 2104;
Description
Right click in the sheet. Arguments: XRange/XSheetCellRangeContainer aRange, [out] boolean bCancel.
WORKSHEET_CALCULATE
const long WORKSHEET_CALCULATE = 2105;
Description
Cells in sheet have been recalculated. Arguments: short nSheet.
WORKSHEET_CHANGE
const long WORKSHEET_CHANGE = 2106;
Description
Cells in sheet have been changed. Arguments: XRange/XSheetCellRangeContainer aRange.
WORKSHEET_SELECTIONCHANGE
const long WORKSHEET_SELECTIONCHANGE = 2107;
Description
Selection in sheet has been changed. Arguments: XRange/XSheetCellRangeContainer aRange.
WORKSHEET_FOLLOWHYPERLINK
const long WORKSHEET_FOLLOWHYPERLINK = 2108;
Description
Hyperlink has been clicked. Arguments: XCell aCell.
USERDEFINED_START
const long USERDEFINED_START = 1000000;
Description
Implementations are allowed to use identifiers above this value for any internal purpose.
Top of Page

Apache Software Foundation

Copyright & License | Privacy | Contact Us | Donate | Thanks

Apache and the Apache feather logo are trademarks of The Apache Software Foundation. OpenOffice, OpenOffice.org and the seagull logo are registered trademarks of The Apache Software Foundation. Other names appearing on the site may be trademarks of their respective owners.