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 document events and at what point an assigned macro is executed.
แแแแแแแ |
An assigned macro is executed... |
routine |
|---|---|---|
แแ แแแ แแแแก แแแฌแงแแแ |
...after a LibreOffice application is started. |
OnStartApp |
แแ แแแ แแแแก แแแฎแฃแ แแ |
...before a LibreOffice application is terminated. |
OnCloseApp |
แแแแฃแแแแขแ แจแแแฅแแแ |
...New document created with File - New or with the New icon. Note that this event also fires when Basic IDE opens. |
OnCreate |
แขแแฅแกแขแฃแ แ แแแแฃแแแแขแ |
...after a new document is created with File - New or with the New icon. |
OnNew |
แแแแฃแแแแขแแก แฉแแขแแแ แแแ แแแกแ แฃแแแ |
...before a document is opened with File - Open or with the Open icon. |
OnLoadFinished |
แแแแฃแแแแขแแก แแแฎแกแแ |
...after a document is opened with File - Open or with the Open icon. |
OnLoad |
แแแแฃแแแแขแ แแแแฎแฃแ แแแ |
...before a document is closed. |
OnPrepareUnload |
แแแแฃแแแแขแ แแแแฎแฃแ แ |
...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 |
|
แฎแแแ แจแแแฅแแแ |
Document is displayed. Note that this event also happens when a document is duplicated. |
OnViewCreated |
แฎแแแ แแแแฎแฃแ แแแ |
Document layout is getting removed. |
OnPrepareViewClosing |
แฎแแแ แแแแฎแฃแ แ |
Document layout is cleared prior to the document closure. |
OnViewClosed |
แแแแฃแแแแขแแก แแฅแขแแแแ แแแ |
...after a document is brought to the foreground. |
OnFocus |
แแแแฃแแแแขแแก แแแแฅแขแแแแ แแแ |
...after another document is brought to the foreground. |
OnUnfocus |
แแแแฃแแแแขแแก แจแแแแฎแแ |
...before a document is saved with File - Save or the Save icon, provided that a document name has already been specified. |
OnSaveAs |
แแแแฃแแแแขแ แจแแแแฎแฃแแแ |
...after a document is saved with File - Save or the Save icon, provided that a document name has already been specified. |
OnSaveDone |
แแแแฃแแแแขแแก แจแแแแฎแแ แฉแแแแ แแ |
Document could not be saved. |
OnSaveFailed |
แแแแฃแแแแขแแก แจแแแแฎแแ แ แแแแ แช |
...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 |
แแแแฃแแแแขแแก แจแแแแฎแฃแแแ แ แแแแ แช |
... 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 |
'Save As' has failed |
Document could not be saved. |
OnSaveAsFailed |
-no UI- |
When the document disk location has changed, for example after a File - Save As action. |
OnStorageChanged |
แแแแฃแแแแขแแก แแกแแแก แจแแแแฎแแ แแ แแแขแแแ |
...before a document is saved with , , or the icons. |
OnCopyTo |
แจแแแฅแแแ แแแแฃแแแแขแแก แแกแแ |
...after a document is saved with , , or the icons. |
OnCopyToDone |
แแแแฃแแแแขแแก แแกแแแก แจแแฅแแแ แฉแแแแ แแ |
Document could not be copied or exported. |
OnCopyToFailed |
แแแแฃแแแแขแแก แแแแแญแแแ |
...after the Print dialog is closed, but before the actual print process begins. This event occurs for each copy printed. |
OnPrint |
-no UI- |
...after document security settings have changed. |
OnModeChanged |
'แจแแชแแแแแแ' แกแขแแขแฃแกแ แจแแแชแแแแ |
Modified state of a document has changed. |
OnModifyChanged |
แแแแฃแแแแขแแก แกแแแแฃแ แ แจแแแชแแแแ |
When the document title gets updated. |
OnTitleChanged |
แฅแแแแแแแแแแแขแ แฉแแแขแแแ แแ |
...after a database form has been opened. |
OnSubComponentOpened |
แฅแแแแแแแแแแแขแ แแแแฎแฃแ แ |
...after a database form has been closed. |
OnSubComponentClosed |
แคแแ แแแก แฌแแ แขแแแแแแก แแแญแแแ แแแแฌแงแ |
...before printing form letters using File - Print or Tools - Mail Merge Wizard menus. |
OnMailMerge |
แคแแ แแแก แฌแแ แแแแแแก แแแญแแแ แแแกแ แฃแแแ |
...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 |
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.
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.