GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
Table of Contents | < < Previous | Next >> |
Chapter Eighteen — DataView Integration (continued)
Overview
The on_file_export_popup event is called when the user selected File | Export ribbon or menu function.
Syntax/Parameters
Syntax
int on_file_export ( int m_x, int m_y ) { ... }
Parameters
m_x
The mouse x position as an int in screen coordinates.
m_y
The mouse y position as an int in screen coordinates.
Return Value
The function is expected to complete the process. An error code can be returned but is presently ignored.
Remarks
This hook allows the export popup menu to be captured and presented by the script. The script is expected to process any selection made by the user.
The top level popup button on the ribbon is always enabled.
Example code:
int on_file_export_popup(int m_x, int m_y) { string list[10]; string s1; int rc; list[0] = "Export iXBRL/HTML..."; list[1] = "Export Plain HTML..."; list[2] = "Export JSON..."; rc = MenuTrackAdHocPopup(list, m_x, m_y); if (rc < 0) { return ERROR_NONE; } // insert processing return ERROR_NONE; }
An ad hoc menu as simple items or as defined functions could be used. A fixed list is used to avoid unnecessary memory trashing.
Related Events and Functions
Page revised 2024-10-21
Table of Contents | < < Previous | Next >> |
© 2012-2024 Novaworks, LLC. All rights reserved worldwide. Unauthorized use, duplication or transmission prohibited by law. Portions of the software are protected by US Patents 10,095,672, 10,706,221 and 11,210,456. GoFiler™ and Legato™ are trademarks of Novaworks, LLC. EDGAR® is a federally registered trademark of the U.S. Securities and Exchange Commission. Novaworks is not affiliated with or approved by the U.S. Securities and Exchange Commission. All other trademarks are property of their respective owners. Use of the features specified in this language are subject to terms, conditions and limitations of the Software License Agreement.