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.

рдШрдЯрдирд╛

рдПрдЙрдЯрд╛ рдорд╛рдирд╛рдЩреНрдХрди рдЧрд░рд┐рдПрдХреЛ рдореНрдпрд╛рдХреНрд░реЛ рдХрд╛рд░реНрдпрд╛рдиреНрд╡рдпрди рдЧрд░рд┐рдпреЛ...

routine

Start Application

...after a LibreOffice application is started.

OnStartApp

Close Application

...рдПрдЙрдЯрд╛ LibreOffice рдЕрдиреБрдкреНрд░рдпреЛрдЧ рд╕рдорд╛рдкреНрдд рдЧрд░реНрдиреБ рдЕрдЧрд╛рдбрд┐

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

...рдкрдЫрд╛рдбрд┐ рдлрд╛рдЗрд▓ - рдирдпрд╛рдБ рд╡рд╛рдирдпрд╛рдБ рдкреНрд░рддрд┐рдорд╛рдмрд╛рдЯ рдПрдЙрдЯрд╛ рдирдпрд╛рдБ рдХрд╛рдЧрдЬрд╛рдд рд╕рд┐рд░реНрдЬрдирд╛ рдЧрд░рд┐рдпреЛ ред

OnNew

Document loading finished

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

OnLoadFinished

рдХрд╛рдЧрдЬрд╛рдд рдЦреЛрд▓реНрдиреБрд╣реЛрд╕реН

...рдкрдЫрд╛рдбрд┐ рдлрд╛рдЗрд▓ - рдЦреЛрд▓реНрдиреБрд╣реЛрд╕реН рд╡рд╛ рдЦреЛрд▓реНрдиреБрд╣реЛрд╕реН рдкреНрд░рддрд┐рдорд╛рдмрд╛рдЯ рдПрдЙрдЯрд╛ рдХрд╛рдЧрдЬрд╛рдд рдЦреЛрд▓рд┐рдпреЛ ред

OnLoad

Document is going to be closed

...рдХрд╛рдЧрдЬрд╛рдд рдмрдиреНрдж рдЧрд░реНрдиреБ рдЕрдЧрд╛рдбрд┐ ред

OnPrepareUnload

рдХрд╛рдЧрдЬрд╛рдд рдмрдиреНрдж рд╣реБрджреИрдЫ ред

...рдХрд╛рдЧрдЬрд╛рдд рдмрдиреНрдж рднрдПрдкрдЫрд┐ ред рдЬрдм рдмрдиреНрдж рдЧрд░реНрдиреБрднрдиреНрджрд╛ рдЖрдЧрд╛рдбрд┐ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реНрджрд╛ рддреНрдпреЛ рдШрдЯрдирд╛ "рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН" рдпрд╛рдж рдЧрд░реНрдиреБрд╣реЛрд╕реН рдпрд╛ рдЖрдлреИ рдЖрдЙрди рдкрдирд┐ рд╕рдХреНрдЫ ред

OnUnload

-no UI-

OnLayoutFinished

View created

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

OnViewCreated

View is going to be closed

Document layout is getting removed.

OnPrepareViewClosing

View closed

Document layout is cleared prior to the document closure.

OnViewClosed

рдХрд╛рдЧрдЬрд╛рдд рд╕рдХреНрд░рд┐рдп рдкрд╛рд░реНрдиреБрд╣реЛрд╕реН

...рдХрд╛рдЧрдЬрд╛рдд рдЕрдЧреНрд░рднреВрдореАрдорд╛ рд▓реНрдпрд╛рдП рдкрдЫрд┐ ред

OnFocus

рдХрд╛рдЧрдЬрд╛рдд рдирд┐рд╕реНрдХреНрд░рд┐рдп рдкрд╛рд░реНрдиреБрд╣реЛрд╕реН

...рдЕрд░реНрдХреЛ рдХрд╛рдЧрдЬрд╛рдд рдкреГрд╖реНрдарднреВрдорд┐рдорд╛ рд▓реНрдпрд╛рдП рдкрдЫрд┐ ред

OnUnfocus

рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН

...рдЕрдЧрд╛рдбрд┐ рдлрд╛рдЗрд▓ - рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН рд╡рд╛ рдкреНрд░рддрд┐рдорд╛рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реНрд╕рдБрдЧ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реЗрдХреЛ рдЫ,рддреНрдпрд╕рд▓реЗ рдкрд╣рд┐рд▓реНрдпреИ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рднрдПрдХреЛ рдХрд╛рдЧрдЬрд╛рддрдХреЛ рдирд╛рдо рдкреНрд░рджрди рдЧрд░реЗрдХреЛ рдерд┐рдпреЛ ред

OnSaveAs

рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рднрдЗрд╕рдХреЗрдХреЛ рдЫ

...рдкрдЫрд╛рдбрд┐ рдлрд╛рдЗрд▓ - рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН рд╡рд╛ рдкреНрд░рддрд┐рдорд╛рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реНрд╕рдБрдЧ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реЗрдХреЛ рдЫ, рддреНрдпрд╕рд▓реЗ рдкрд╣рд┐рд▓реНрдпреИ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рднрдПрдХреЛ рдХрд╛рдЧрдЬрд╛рддрдХреЛ рдирд╛рдо рдкреНрд░рджрди рдЧрд░реЗрдХреЛ рдерд┐рдпреЛ ред

OnSaveDone

Saving of document failed

Document could not be saved.

OnSaveFailed

рдпрд╕ рд░реВрдкрдорд╛ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН

...рдЕрдЧрд╛рдбрд┐ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдирд╛рдо (рдлрд╛рдЗрд▓ - рдпрд╕ рд░реВрдкрдорд╛ рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН, рд╡рд╛ рдлрд╛рдЗрд▓ - рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН рд╡рд╛ рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН рдкреНрд░рддрд┐рдорд╛ рдХреЛ рддрд▓ рдПрдЙрдЯрд╛ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рдЧрд░рд┐рдпреЛ, рдпрджрд┐ рдХрд╛рдЧрдЬрд╛рдд рдирд╛рдо рдЕрд╣рд┐рд▓реЗ рд╕рдореНрдо рдкрдирд┐ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдЧрд░рд┐рдПрдХреЛ рдЫреИрди рднрдиреЗ) ред

OnSaveAs

рдХрд╛рдЧрдЬрд╛рдд рдпрд╕ рд░реВрдкрд╛рдорд╛ рдмрдЪрдд рдЧрд░рд┐рд╕рдХрд┐рдПрдХреЛ рдЫ ред

...рдкрдЫрд╛рдбрд┐ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдирд╛рдордХреЛ рддрд▓ рдХрд╛рдЧрдЬрд╛рдд рдмрдЪрдд рднрдПрдХреЛ рдерд┐рдпреЛ(рдлрд╛рдЗрд▓ - рдпрд╕рд░реВрдкрдорд╛ рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН, рд╡рд╛ рдлрд╛рдЗрд▓ - рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН рд╡рд╛ рдкреНрд░рддрд┐рдорд╛рд╕рдБрдЧ рдмрдЪрдд рдЧрд░реНрдиреБрд╣реЛрд╕реН, рдпрджрд┐ рдХрд╛рдЧрдЬрд╛рдд рдирд╛рдо рдЕрд╣рд┐рд▓реЗ рд╕рдореНрдо рдкрдирд┐ рдирд┐рд░реНрджрд┐рд╖реНрдЯ рдЧрд░рд┐рдПрдХреЛ рдЫреИрди рднрдиреЗ) ред

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

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

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

Creating of document copy failed

Document could not be copied or exported.

OnCopyToFailed

Print 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

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

OnSubComponentClosed

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

рдкреГрд╖реНрда рдЧрдгрдирд╛рдХреЛ рдкрд░рд┐рд╡рд░реНрддрди рдЧрд░реНрдиреБрд╣реЛрд╕реН

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.


рдШрдЯрдирд╛рдорд╛ рдореНрдпрд╛рдХреНрд░реЛ рдорд╛рдирд╛рдЩреНрдХрди

  1. рдЙрдкрдХрд░рдгрд╣рд░реВ - рдЕрдиреБрдХреВрд▓рди рд░реЛрдЬреНрдиреБрд╣реЛрд╕реН рд░ рдШрдЯрдирд╛рд╣рд░реВ рдЯреНрдпрд╛рдм рдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  2. рд╕рдЩреНрдЧреНрд░рд╣ рдЧрд░реНрдиреБрд╣реЛрд╕реН рд╡рд┐рдХрд▓реНрдк рдЪрдпрди рдЧрд░реЗрд░ рддрдкрд╛рдИрдБрд▓реЗ рдорд╛рдирд╛рдЩреНрдХрди рд╡рд┐рд╢реНрд╡рд╡реНрдпрд╛рдкреА рд░реВрдкрдорд╛ рд╡реИрдз рдЧрд░рд╛рдЙрди рдЪрд╛рд╣рдиреБрд╣реБрдиреНрдЫ рдЕрдерд╡рд╛ рдпреЛ рдХрд╛рдЧрдЬрд╛рддрдорд╛ рдорд╛рддреНрд░ рд╡реИрдз рдЧрд░рд╛рдЙрди рдЪрд╛рд╣рдиреБрд╣реБрдиреНрдЫ рднрдиреНрдиреЗ рдХреБрд░рд╛ рдЪрдпрди рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  3. рдШрдЯрдирд╛рд╕реВрдЪреАрдмрд╛рдЯ рдШрдЯрдирд╛ рдЪрдпрди рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  4. рдореНрдпрд╛рдХреНрд░реЛрд╣рд░реВрд╕реВрдЪреАрдмрд╛рдЯ рдЪрдпрди рдЧрд░рд┐рдПрдХреЛ рдШрдЯрдирд╛рд▓рд╛рдИ рдорд╛рдирд╛рдЩреНрдХрди рдЧрд░реНрди рдореНрдпрд╛рдХреНрд░реЛ рд╕рдорд╛рд╡реЗрд╢ рдореЛрдбреНрдпреБрд▓ рдЪрдпрди рдЧрд░реНрдиреБрд╣реЛрд╕реН ред рдпреЛ рд╕реВрдЪреАрд▓реЗ рдореЛрдбреНрдпреБрд▓рд╣рд░реВ,рд▓рд╛рдЗрдмреНрд░реЗрд░реАрд╣рд░реВ,рдлрд╛рдЗрд▓рд╣рд░реВ,рд░ рдЯреЗрдореНрдкреНрд▓реЗрдЯрд╣рд░реВрдХреЛ рд╕реВрдЪреАрд▓рд╛рдИ рддрд╣рдЧрдд рд░реВрдкрдорд╛ рд╕рдорд╛рд╡реЗрд╢ рдЧрд░рд╛рдЙрдЫ ред

  5. рдорд╛рдирд╛рдЩреНрдХрдирдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  6. рд╕рдВрд╡рд╛рдж рдмрдиреНрдж рдЧрд░реНрди рдареАрдХ рдЫ рдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

рдШрдЯрдирд╛рдмрд╛рдЯ рдореНрдпрд╛рдХреНрд░реЛрдХреЛ рдХрд╛рд░реНрдп рд╣рдЯрд╛рдЙрджреИ

  1. рдЙрдкрдХрд░рдгрд╣рд░реВ - рдЕрдиреБрдХреВрд▓рди рд░реЛрдЬреНрдиреБрд╣реЛрд╕реН рд░ рдШрдЯрдирд╛рд╣рд░реВ рдЯреНрдпрд╛рдм рдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  2. рдХреГрдкрдпрд╛ рддрд▓рдХрд╛ рдмреБрджрд╛ рдмрд╛рдХрд╕рдорд╛ рд╡рд┐рдХрд▓реНрдк рдЪрдпрди рдЧрд░реА рддрдкрд╛рдИрдБ рд╡рд┐рд╢реНрд╡рд╡реНрдпрд╛рдкреА рдХрд╛рд░реНрдп рд╣рдЯрд╛рдЙрди рдЪрд╛рд╣рдиреБрд╣реБрдиреНрдЫ рд╡рд╛ рдпрд╣рд╛рдБ рднрдПрдХреЛ рдХрд╛рд░реНрдпрд╣рд╛рд▓рдХреЛ рдХрд╛рдЧрдЬрд╛рддрдорд╛ рдорд╛рддреНрд░реИ рд╡реИрдз рдЧрд░реНрди рдЪрд╣рд╛рдиреБрд╣реБрдиреНрдЫ рдЪрдпрди рдЧрд░реНрдиреБрд╣реЛрд╕реН:|

  3. рдШрдЯрдирд╛ рд╕реВрдЪреАрдмрд╛рдЯ рд╣рдЯрд╛рдЗрдиреЗ рдХрд╛рд░реНрдпрд╣рд░реВ рд╕рдорд╛рд╡реЗрд╢ рдЧрд░реНрдиреЗ рдШрдЯрдирд╛ рдЪрдпрди рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  4. рд╣рдЯрд╛рдЙрдиреБрд╣реЛрд╕реНрдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

  5. рд╕рдВрд╡рд╛рдж рдмрдиреНрдж рдЧрд░реНрди рдареАрдХ рдЫ рдХреНрд▓рд┐рдХ рдЧрд░реНрдиреБрд╣реЛрд╕реН ред

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

Please support us!