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.

Eveniment

An assigned macro is executed...

routine

Pornește aplicația

...after a LibreOffice application is started.

OnStartApp

Închide aplicația

...before a LibreOffice application is terminated.

OnCloseApp

Documentul a fost creat

...New document created with File - New or with the New icon. Note that this event also fires when Basic IDE opens.

OnCreate

Document nou

...after a new document is created with File - New or with the New icon.

OnNew

Încărcarea documentului s-a încheiat

...before a document is opened with File - Open or with the Open icon.

OnLoadFinished

Deschide documentul

...after a document is opened with File - Open or with the Open icon.

OnLoad

Închide documentul

...before a document is closed.

OnPrepareUnload

Documentul se închide

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

Vizualizare creată

Document is displayed. Note that this event also happens when a document is duplicated.

OnViewCreated

Vederea este pe cale de a fi închisă

Document layout is getting removed.

OnPrepareViewClosing

Vederea a fost închisă

Document layout is cleared prior to the document closure.

OnViewClosed

Activează documentul

...after a document is brought to the foreground.

OnFocus

Dezactivează documentul

...after another document is brought to the foreground.

OnUnfocus

Salvează documentul

...before a document is saved with File - Save or the Save icon, provided that a document name has already been specified.

OnSaveAs

Documentul a fost salvat

...after a document is saved with File - Save or the Save icon, provided that a document name has already been specified.

OnSaveDone

Salvarea documentului a eșuat

Document could not be saved.

OnSaveFailed

Salvează document ca

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

Documentul a fost salvat ca

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

Stocarea sau exportul unei copii a documentului

...before a document is saved with File - Save a Copy, File - Export, File - Export as PDF or the Save icons.

OnCopyTo

Copia documentului a fost creată

...after a document is saved with File - Save a Copy, File - Export, File - Export as PDF or the Save icons.

OnCopyToDone

Crearea copiei documentului a eșuat

Document could not be copied or exported.

OnCopyToFailed

Imprimare document

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

Starea „Modificat” a fost schimbată

Modified state of a document has changed.

OnModifyChanged

Titlul documentului s-a modificat

When the document title gets updated.

OnTitleChanged

Am încărcat o sub-componentă

...after a database form has been opened.

OnSubComponentOpened

Am închis o sub-componentă

...after a database form has been closed.

OnSubComponentClosed

Tipărirea scrisorilor formular a început

...before printing form letters using File - Print or Tools - Mail Merge Wizard menus.

OnMailMerge

Tipărirea scrisorilor formular s-a încheiat

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


note

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.


tip

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.

Please support us!