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

Table of Contents	< < Previous	Next >>

 

Chapter Seventeen — Application Integration Functions (continued)

MenuGetBitmapName Function

Overview

The MenuGetBitmapName function retrieves the base name of the bitmap used for display on menus and the ribbon.

Syntax/Parameters

Syntax

string = MenuGetBitmapName ( 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 containing the raw bitmap name or an empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

Bitmaps are used on the ribbon display and on popup menus. The bitmap name can be a filename or a resource name. If it is a resource name, it will not contain an extension and may have one or more suffixes: none, name as specified for a small bitmap, “_l” for large bitmap, or “_” for a combination of large and small. Large bitmaps are 40x35 pixels while small bitmaps are 20x20 pixels.

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.

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

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

MenuGetFunctionID — Gets the integer for the function by table index or Function Code.

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.