Contents

# 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
Text Document | ...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 File - Save a Copy, File - Export, File - Export as PDF or the Save icons. | OnCopyTo
દસ્તાવેજ નકલ ને બનાવી દેવામાં આવી છે | ...after a document is saved with File - Save a Copy, File - Export, File - Export as PDF or the Save 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

1. Choose Tools - Customize and click the Events tab.

2. Select whether you want the assignment to be globally valid or just valid in the current document in the Save In listbox.

3. Select the event from the Event list.

4. Click Macro and select the macro to be assigned to the selected event.

5. Click OK to append the library.

6. Click OK to append the library.

## Removing the Assignment of a Macro to an Event

1. Choose Tools - Customize and click the Events tab.

2. 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.

3. Select the event that contains the assignment to be removed from the Event list.

4. Click Remove.

5. Click OK to append the library.

Related Topics

In addition to assigning macros to events, one can monitor events triggered in LibreOffice documents.