Namespace: Consultingwerk.SmartFramework.Repository.ContextMenu
Class 
ContextMenuParser Copy to Clipboard
Parent classes:
Progress.Lang.Object
Consultingwerk.SmartFramework.Repository.ContextMenu.ContextMenuParser

Inherits: Progress.Lang.Object


Navigate to: Methods | Constructors | Events | Properties | ProDatasets | Temp-Tables



Top Method Summary
Options Name Purpose
LOGICAL AddEntry (character, integer, character) Adds an entry to the ttContextMenuEntry temp-table
CHARACTER Format (table) Formats the entries of a context menu as a ContextMenu attribute value
CHARACTER GetMessageText (integer, character, character) Returns the text of a message of the SmartFramework Message Dictionary
CHARACTER GetToolIds (character) Returns the ids of all tools of a context menu
Parse (character, table) Parses a ContextMenu attribute value
SetChildCount (integer, integer) Assigns the number of tools of a submenu entry


Method Detail
Top

LOGICAL AddEntry (character, integer, character)
Purpose: Adds an entry to the ttContextMenuEntry temp-table
Notes: Blanks around the tool id are ignored, an empty tool id does not
produce an entry

Parameters:
pcToolId CHARACTER
The id of the tool
piParentSequence INTEGER
The EntrySequence of the submenu entry or 0 for an entry of the context menu itself
pcParentToolId CHARACTER
The id of the submenu tool or the empty value for an entry of the context menu itself
Returns LOGICAL
Logical value indicating if an entry was added
Top

CHARACTER Format (table)
Purpose: Formats the entries of a context menu as a ContextMenu attribute value
Notes: Produces the canonical notation, e.g.
TableIOCreate,PrintSubmenu (PrintTool,PreviewTool)

Parameters:
ttContextMenuEntry TEMP-TABLE ttContextMenuEntry
The entries of the context menu
Returns CHARACTER
The ContextMenu attribute value
Top

CHARACTER GetMessageText (integer, character, character)
Purpose: Returns the text of a message of the SmartFramework Message Dictionary
Notes:

Parameters:
piMessageNumber INTEGER
The number of the message in the SFR group
pcParameter1 CHARACTER
The first message parameter
pcParameter2 CHARACTER
The second message parameter
Returns CHARACTER
The message text
Top

CHARACTER GetToolIds (character)
Purpose: Returns the ids of all tools of a context menu
Notes: Returns the tools of the context menu and of its submenus in the
order of their appearance, every tool id once

Parameters:
pcContextMenu CHARACTER
The ContextMenu attribute value
Returns CHARACTER
The comma-delimited list of the tool ids
Top

Parse (character, table)
Purpose: Parses a ContextMenu attribute value
Notes: Raises an InvalidContextMenuException for an unbalanced or nested
parenthesis, for parentheses that do not follow a tool, for an
empty list of submenu tools and for text between a closing
parenthesis and the next comma

Parameters:
pcContextMenu CHARACTER
The ContextMenu attribute value
ttContextMenuEntry TEMP-TABLE ttContextMenuEntry
OUTPUT The entries of the context menu
Top

SetChildCount (integer, integer)
Purpose: Assigns the number of tools of a submenu entry
Notes:

Parameters:
piEntrySequence INTEGER
The EntrySequence of the submenu entry
piChildCount INTEGER
The number of tools of the submenu


Temp-Table Detail

Temp-Table ttContextMenuEntry

Defined in:


©2006-2026 Consultingwerk Ltd.         info@consultingwerk.de         http://www.consultingwerk.de       09.11.2026 08:11:06