GoFiler Legato Script Reference   Legato v 1.5d Application v 5.25a

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

MenuGetFunctionID Function

Overview

The MenuGetFunctionID function will retrieve the function ID by index position or function code.

Syntax/Parameters

Syntax

int = MenuGetFunctionID ( 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 an int containing the function ID or -1 on error. Use the GetLastError function to retrieve error information.

Remarks

Note that function IDs are not constant between application releases and should not be permanently coded into scripts. Function ID values are coded as part of the resources of the application and are occasionally subject to being reorganized or regrouped as new features are added.

Related Functions

MenuEnumerateFunctions — Returns a table of all of properties for all functions.

MenuFindFunctionID — Finds function’s ID by Function Code.

MenuFindFunctionIndex — Finds a function's table index by Function Code.

MenuGetBitmapName — Gets the bitmap name for the function by table index or Function Code.

MenuGetDescription — Gets the description for the function by table index or Function Code.

MenuGetFunctionCode — Gets the Function Code (string) by table index only.

MenuGetFunctionProperties — Returns an array of properties for a specified function.

MenuGetMenuName — Gets the menu text for the function by table index or Function Code.

MenuGetRibbonName — Gets the ribbon text for the function by table index or Function Code.

Platform Support

Go13, Go16, GoFiler Complete, GoFiler Corporate, GoFiler, GoFiler Lite, GoXBRL

Legato IDE, Legato Basic

 

Table of Contents	< < Previous	Next >>

GoFiler Legato Script Reference — Generated on 12/16/2024

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