(Created page with "ListActions are .......... The content for this page will be added soon.") |
No edit summary |
||
| (14 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
ListActions | ListActions returns all available actions of a Nesting. The method is available within the context of the ViewModel for customizing the display of actions within the UI. | ||
==== OCL Expression ==== | |||
<syntaxhighlight> | |||
selfVM.ListActions(<nameofNesting>) | |||
</syntaxhighlight> | |||
=== '''Argument''' === | |||
<code>nameofNesting</code>: '''String''' | |||
String name of Nesting. Use [[Documentation:Nestings|selfVM.Nesting]] to set the nesting name for better error checking when the name of a nesting is changed. | |||
'''Return Type''' | |||
<code>Collection(ActionInstance)</code> | |||
List of the Action objects | |||
=== '''ActionInstance Attributes''' === | |||
'''<code>ActionName</code>: String''' | |||
Name of the action. | |||
'''<code>Enabled</code>: Boolean''' | |||
true if action is enabled. | |||
'''<code>Group</code>: String''' | |||
Name of menu group for action | |||
'''<code>Hint</code>: String''' | |||
Extra information showed when your mouse is over the Action UI widget. Hint is available for both enabled and disabled Action. | |||
'''<code>IsNavigating</code>: Boolean''' | |||
true if action navigates to another ViewModel | |||
'''<code>NestingName</code>: String''' | |||
Name of ViewModel Nesting | |||
'''<code>Presentation</code>: String''' | |||
String representation of ViewModel | |||
==== See also: ==== | |||
* [[Documentation:SelfVM|SelfVM]] | |||
* [[Documentation:Nestings|Nestings]] | |||
Latest revision as of 05:34, 19 September 2024
ListActions returns all available actions of a Nesting. The method is available within the context of the ViewModel for customizing the display of actions within the UI.
OCL Expression
selfVM.ListActions(<nameofNesting>)Argument
nameofNesting: String
String name of Nesting. Use selfVM.Nesting to set the nesting name for better error checking when the name of a nesting is changed.
Return Type
Collection(ActionInstance)
List of the Action objects
ActionInstance Attributes
ActionName: String
Name of the action.
Enabled: Boolean
true if action is enabled.
Group: String
Name of menu group for action
Hint: String
Extra information showed when your mouse is over the Action UI widget. Hint is available for both enabled and disabled Action.
IsNavigating: Boolean
true if action navigates to another ViewModel
NestingName: String
Name of ViewModel Nesting
Presentation: String
String representation of ViewModel