From 5c93f0a8c1233c584aac64be9dc77d49bf074ade Mon Sep 17 00:00:00 2001 From: Alain Romedenne Date: Fri, 11 Sep 2020 14:59:03 +0200 Subject: tdf#92183 Documents events refresher Removed items: JScript runtime error, Print mail merge, Message received Added items: too many to mention This wiki WiP page details the - very limited - API sources I used: https://wiki.documentfoundation.org/User:LibreOfficiant/Events#Events_in_Documents Change-Id: I2f0b85f17fde9b99a2c7ee407d593d3c9207e4d3 Reviewed-on: https://gerrit.libreoffice.org/c/help/+/102426 Tested-by: Jenkins Reviewed-by: Olivier Hallot --- source/text/sbasic/shared/01040000.xhp | 330 ++++++++++++++++++--------------- 1 file changed, 178 insertions(+), 152 deletions(-) (limited to 'source') diff --git a/source/text/sbasic/shared/01040000.xhp b/source/text/sbasic/shared/01040000.xhp index c9b9c9b867..87b04a6a57 100644 --- a/source/text/sbasic/shared/01040000.xhp +++ b/source/text/sbasic/shared/01040000.xhp @@ -18,210 +18,236 @@ * except in compliance with the License. You may obtain a copy of * the License at http://www.apache.org/licenses/LICENSE-2.0 . --> - - + - Event-Driven Macros + Document Event-Driven Macros /text/sbasic/shared/01040000.xhp

-deleting; macro assignments to events + + deleting; macro assignments to events macros; assigning to events assigning macros to events + documents; events events; assigning macros - -Event-Driven Macros - This section describes how to assign Basic programs to program events. + +

Document Event-Driven Macros

+ This section describes how to assign scripts to application, document or form events.

- You can automatically execute a macro when a specified software event occurs by assigning the desired macro to the event. The following table provides an overview of program events and at what point an assigned macro is executed. + You can automatically execute a macro when a specified software event occurs by assigning the desired macro to the event. The following table provides an overview of document events and at what point an assigned macro is executed. + - - Event - - - An assigned macro is executed... - + Event + An assigned macro is executed... + routine + + + Start Application + ...after a $[officename] application is started. + OnStartApp + + + Close Application + ...before a $[officename] application is terminated. + OnCloseApp + + + Document created + ...New document created with File - New or with the New icon. Note that this event also fires when Basic IDE opens. + OnCreate + + + New Document + ...after a new document is created with File - New or with the New icon. + OnNew + + + Document loading finished + ...before a document is opened with File - Open or with the Open icon. + OnLoadFinished + + + Open Document + ...after a document is opened with File - Open or with the Open icon. + OnLoad + + + Document is going to be closed + ...before a document is closed. + OnPrepareUnload + + + Document closed + ...after a document was closed. Note that the "Save Document" event may also occur when the document is saved before closing. + OnUnload + + + -no UI- + + OnLayoutFinished + + + View created + Document is displayed. Note that this event also happens when a document is duplicated. + OnViewCreated - - Program Start - - - ... after a $[officename] application is started. - + View is going to be closed + Document layout is getting removed. + OnPrepareViewClosing - - Program End - - - ...before a $[officename] application is terminated. - + View closed + Document layout is cleared prior to the document closure. + OnViewClosed - - Create Document - - - ...after a new document is created with File - New or with the New icon. - + Activate Document + ...after a document is brought to the foreground. + OnFocus - - Open Document - - - ...after a document is opened with File - Open or with the Open icon. - + Deactivate Document + ...after another document is brought to the foreground. + OnUnfocus - - Save Document As - - - ...before a document is saved under a specified name (with File - Save As, or with File - Save or the Save icon, if a document name has not yet been specified). - + Save Document + ...before a document is saved with File - Save or the Save icon, provided that a document name has already been specified. + OnSaveAs - - Document has been saved as - - - ... after a document was saved under a specified name (with File - Save As, or with File - Save or with the Save icon, if a document name has not yet been specified). - + Document has been saved + ...after a document is saved with File - Save or the Save icon, provided that a document name has already been specified. + OnSaveDone - - Save Document - - - ...before a document is saved with File - Save or the Save icon, provided that a document name has already been specified. - + Saving of document failed + Document could not be saved. + OnSaveFailed - - Document has been saved - - - ...after a document is saved with File - Save or the Save icon, provided that a document name has already been specified. - + Save Document As + ...before a document is saved under a specified name (with File - Save As, or with File - Save or the Save icon, if a document name has not yet been specified). + OnSaveAs - - Document is closingi104852 - - - ...before a document is closed. - + Document has been saved as + ... after a document was saved under a specified name (with File - Save As, or with File - Save or with the Save icon, if a document name has not yet been specified). + OnSaveAsDone - - Document closed - - - ...after a document was closed. Note that the "Save Document" event may also occur when the document is saved before closing. - + 'Save As' has failed + Document could not be saved. + OnSaveAsFailed - - Activate Document - - - ...after a document is brought to the foreground. - + -no UI- + When the document disk location has changed, for example after a File - Save As... action. + OnStorageChanged - - Deactivate Document - - - ...after another document is brought to the foreground. - + Storing or exporting copy of document + ...before a document is saved with File - Save a Copy, File - Export, File - Export as PDF or the Save icons. + OnCopyTo - - Print Document - - - ...after the Print dialog is closed, but before the actual print process begins. - + Document copy has been created + ...after a document is saved with File - Save a Copy, File - Export, File - Export as PDF or the Save icons. + OnCopyToDone - - JavaScript run-time error - - - ...when a JavaScript run-time error occurs. - + Creating of document copy failed + Document could not be copied or exported. + OnCopyToFailed - - Print Mail Merge - - - ...after the Print dialog is closed, but before the actual print process begins. This event occurs for each copy printed. - + Print document + ...after the Print dialog is closed, but before the actual print process begins. This event occurs for each copy printed. + OnPrint - - Change of the page count - - - ...when the page count changes. - + -no UI- + ...after document security settings have changed. + OnModeChanged - - Message received - - - ...if a message was received. - + 'Modified' status was changed + Modified state of a document has changed. + OnModifyChanged + + + Document title changed + When the document title gets updated. + OnTitleChanged + + + Loaded a sub component + ...after a database form has been opened. + OnSubComponentOpened + + + Closed a sub component + ...after a database form has been closed. + OnSubComponentCloseded + + + Printing of form letters started + ...before printing form letters using File - Print or Tools - Mail Merge Wizard menus. + OnMailMerge + + + Printing of form letters finished + ...after printing of form letters using File - Print or Tools - Mail Merge Wizard menus. + OnMailMergeFinished + + + Printing of form fields started + ...before printing form fields. + OnFieldMerge + + + Printing of form fields finished + ...after printing form fields. + OnFieldMergeFinished + + + Change of the page count + When the page count changes. + OnPageCountChanged

- Assigning a Macro to an Event + Most events relate to documents, except OnStartApp, OnCloseApp, OnCreate and OnLoadFinished that occur at application level. OnSubComponentOpened, and OnSubComponentClosed events are fired by database's forms. + + Writer documents are triggering those specific events: OnLayoutFinished, OnMailMerge, OnMailMergeFinished, OnFieldMerge, OnFieldMergeFinished and OnPageCountChanged. + +

Assigning a Macro to an Event

- - Choose Tools - Customize and click the Events tab. - - - Select whether you want the assignment to be globally valid or just valid in the current document in the Save In listbox. - - - Select the event from the Event list. - - - Click Macro and select the macro to be assigned to the selected event. - - - Click OK to assign the macro. - - - Click OK to close the dialog. - + Choose Tools - Customize and click the Events tab. + Select whether you want the assignment to be globally valid or just valid in the current document in the Save In listbox. + Select the event from the Event list. + Click Macro and select the macro to be assigned to the selected event. + Click OK to assign the macro. + Click OK to close the dialog. - Removing the Assignment of a Macro to an Event + +

Removing the Assignment of a Macro to an Event

- - Choose Tools - Customize and click the Events tab. - - - Select whether you want to remove a global assignment or an assignment that is just valid in the current document by selecting the option in the Save In listbox. - - - Select the event that contains the assignment to be removed from the Event list. - - - Click Remove. - - - Click OK to close the dialog. - + Choose Tools - Customize and click the Events tab. + Select whether you want to remove a global assignment or an assignment that is just valid in the current document by selecting the option in the Save In listbox. + Select the event that contains the assignment to be removed from the Event list. + Click Remove. + Click OK to close the dialog. + +

+ In addition to assigning macros to events, one can monitor events triggered in %PRODUCTNAME documents. +

+ - \ No newline at end of file + -- cgit