ListActions
No edit summary
No edit summary
Line 4: Line 4:
<syntaxhighlight>
<syntaxhighlight>
selfVM.ListActions(<nameofNesting>)
selfVM.ListActions(<nameofNesting>)
</syntaxhighlight>'''Argument'''
</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 17:
List of the Action objects
List of the Action objects


==== '''ActionInstance Attributes''' ====
=== '''ActionInstance Attributes''' ===
'''<code>ActionName</code>: String'''
'''<code>ActionName</code>: String'''


Line 31: Line 32:
'''<code>Hint</code>: String'''
'''<code>Hint</code>: String'''


Extra information showed when mouse is over the Action UI widget. Hint is available for both enabled disabled Action.
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'''
'''<code>IsNavigating</code>: Boolean'''
Line 44: Line 45:


String representation of ViewModel
String representation of ViewModel
<br />


==== See also: ====
==== See also: ====

Revision as of 05:34, 19 September 2024

This page was created by Stephanie@mdriven.net on 2024-06-10. Last edited by Edgar on 2025-01-20.

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

See also: