Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5d

Application v 5.25a

  

 

Chapter Seventeen — Application Integration Functions (continued)

MenuGetFunctionProperties Function

Overview

The MenuGetFunctionProperties function retrieves all the properties associated with a specified menu function.

Syntax/Parameters

Syntax

string[] = MenuGetFunctionProperties ( 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 array with items by key name or an empty array on failure. Use the GetLastError function to retrieve error information.

Remarks

The function returns the following key names:

  Key Name   Description  
  FunctionID   Numerical function ID.  
  FunctionCode   Function code.  
  PassToCode   Hexadecimal string. Reserved.  
  ControlFlags  

Hexadecimal string. Specifies various behaviors and availability:

MF_DOCK_COMMAND   0x00010000   Dock has priority
MF_BOLD_COMMAND   0x00020000   Bold Command
MF_VOLATILE_NAME  0x00040000   Name is Volatile
MF_DEV_COMMAND    0x00100000   Command is Developer
MF_OBS_COMMAND    0x00200000   Command is Obsolete
MF_POP_COMMAND    0x00400000   Command is only on Popups
MF_SUB_COMMAND    0x00800000   Command is Submenu
MF_COMMON_COMMAND 0x01000000   Command is Common 

  
  KeyCode   Hexadecimal string. Reserved.  
  KeyFlags   Hexadecimal string. Reserved.  
  RibbonShortcut   Key for function for ribbon Alt+ key sequence. Can be 0 to 3 characters.  
  QuickKey   If a programmable quick key has been mapped, the ticked of the quick key is placed here.  
  PopupHandle   Hexadecimal string. Reserved.  
  EnableState  

A string of optional enable/disable codes:

A   Any State (always enabled)
B   Clipboard Available
C   File Changed (edit actions set)
D   Always Disabled
E   Edit Window (any edit class)
F   Find Data Available
P   Popup Menu (non-enable, marker)
R   Redo Available
S   Selected Text
U   Undo Available
W   Any Window
X   Exception (calls back) 

  
  FunctionClass   Function or ribbon class, for grouping. For quick key functions, a code indicating: “M” mapped; “R” reserved, “-” not mapped.  
  MenuEntryText   Popup menu entry text. The entry can have a & to mark an underline key position. The menu text may or may not have a quick key attached. For quick key functions, this field contains the reserved function code, i.e., the code associated with the key.  
  Ribbon   Text that appears with icon in the ribbon. Display style depends on the ribbon data files.  
  ShortDescription   Short description. Not populated for all functions. “[TBD]” appears if the function is not complete within the application’s code. For quick key functions, this field contains the text of the quick key combination.  
  LongDescription   The description that appears in popup tips or in the status bar. The text may or may not have quick key text.  
  BitmapName   Name of bitmap for icon(s).  
  SmallIconHandle   Hexadecimal string of handle, if loaded.  
  LargeIconHandle   Hexadecimal string of handle, if loaded.  
  SmallIconGrayedHandle   Hexadecimal string of handle, if created.  
  LargeIconGrayedHandle   Hexadecimal string of handle, if created.  

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.

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

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

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

 

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.