Documentation:ListActions: Difference between revisions

ListActions

Revision as of 11:53, 16 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 nesting name for better error checking when name of 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 mouse is over the Action UI widget. Hint is available for both enabled disabled Action.

IsNavigating: Boolean

true if action navigates to another ViewModel

NestingName: String

Name of ViewModel Nesting

Presentation: String

String representation of ViewModel

@@ Line 1: / Line 1: @@
 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.
-{| class="wikitable"
-!OCL
-!
-|-
-|selfVM.ListActions(<nameofNesting>)
-|Returns all available actions of Nesting
-|}
-'''Argument'''
-<code>nameofNesting</code>: String
+==== OCL Expression ====
+<syntaxhighlight>
+selfVM.ListActions(<nameofNesting>)
+</syntaxhighlight>'''Argument'''
+<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.
@@ Line 20: / Line 17: @@
 ==== '''ActionInstance Attributes''' ====
-'''ActionName: String'''
+'''<code>ActionName</code>: String'''
 Name of the action.
-'''Enabled: Boolean'''
+'''<code>Enabled</code>: Boolean'''
 true if action is enabled.
-'''Group: String'''
+'''<code>Group</code>: String'''
-'''Hint: String'''
+Name of menu group for action
-IsNavigating: Boolean
+'''<code>Hint</code>: String'''
-'''NestingName: String'''
+Extra information showed when mouse is over the Action UI widget. Hint is available for both enabled disabled Action.
+'''<code>IsNavigating</code>: Boolean'''
+true if action navigates to another ViewModel
+'''<code>NestingName</code>: String'''
 Name of ViewModel Nesting
-'''Presentation: String'''
+'''<code>Presentation</code>: String'''
 String representation of ViewModel
+<br />
 ==== See also: ====