Legato
Legato

GoFiler Legato Script Reference

 

Legato v 1.5b

Application v 5.24b

  

 

Chapter SeventeenApplication Integration Functions (continued)

MenuGetRibbonName Function

Overview

The MenuGetRibbonName function retrieves the text for the display of a function on a ribbon.

Syntax/Parameters

Syntax

string = MenuGetRibbonName ( string name | 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 an index to the function table. When index is supplied, code cannot be used.

Return Value

Returns a string containing the ribbon text or empty string on failure. Use the GetLastError function to retrieve error information.

Remarks

Frequently, the ribbon text will be very short. It is meant to be read in context within a ribbon group. For example, the function DOCUMENT_DIVISION_CREATE has the ribbon text “Create”. This may seem ambiguous except that the function is placed inside the “Divisions” ribbon group.

Related Functions

Platform Support

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

Legato IDE, Legato Basic