  |
GoFiler Legato Script Reference
Legato v 1.5b Application v 5.24b
|
| Table of Contents | < < Previous | Next >> |
Chapter Seventeen — Application Integration Functions (continued)
Overview
The MenuGetDescription function retrieves the long description of a menu item.
Syntax/Parameters
Syntax
string = MenuGetDescription ( string code | int index );
Parameters
code
A string containing the specific code for a function (for example, “EDGAR_SUBMIT_TEST”). When code is supplied, id cannot be used.
index
An int specifying the function index as returned to the script from various menu functions. This number can be change between various versions of the application, therefore programmers should not rely on a fixed index to reference functions. When index is supplied, code cannot be used.
Return Value
Returns a string with the long description name or an empty string on failure. Use the GetLastError function to retrieve error information.
Remarks
The long description will contain simple HTML for bold and italic and may also return return characters (0x0D) to mark new lines for tool tips.
Related Functions
Platform Support
Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL
Legato IDE, Legato Basic
| 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.