Charles Olet (talk | contribs) |
(Added Edited template with July 12, 2025.) |
||
| (3 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Edited|July|12|2025}} | |||
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. | 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. | ||
| Line 4: | Line 5: | ||
<syntaxhighlight> | <syntaxhighlight> | ||
selfVM.ListActions(<nameofNesting>) | selfVM.ListActions(<nameofNesting>) | ||
</syntaxhighlight> | </syntaxhighlight> | ||
=== '''Argument''' === | |||
<code>nameofNesting</code>: '''String''' | <code>nameofNesting</code>: '''String''' | ||
String name of Nesting. Use [[Documentation:Nestings|selfVM.Nesting]] to set nesting name for better error checking when name of nesting is changed. | 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''' | '''Return Type''' | ||
| Line 16: | Line 18: | ||
List of the Action objects | List of the Action objects | ||
=== '''ActionInstance Attributes''' === | |||
'''ActionName: String''' | '''<code>ActionName</code>: String''' | ||
Name of the action. | Name of the action. | ||
'''Enabled: Boolean''' | '''<code>Enabled</code>: Boolean''' | ||
true if action is enabled. | true if action is enabled. | ||
'''Group: String''' | '''<code>Group</code>: String''' | ||
Name of menu group for action | Name of menu group for action | ||
'''Hint: String''' | '''<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. | |||
'''IsNavigating: Boolean''' | '''<code>IsNavigating</code>: Boolean''' | ||
true if action navigates to another ViewModel | true if action navigates to another ViewModel | ||
'''NestingName: String''' | '''<code>NestingName</code>: String''' | ||
Name of ViewModel Nesting | Name of ViewModel Nesting | ||
'''Presentation: String''' | '''<code>Presentation</code>: String''' | ||
String representation of ViewModel | String representation of ViewModel | ||
Latest revision as of 06:30, 20 January 2025
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