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
ტექსტური დოკუმენტი | ...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 assign the macro.

6. Click OK to close the dialog.

## 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 close the dialog.

დაკავშირებული თემები

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