Documentation:ListActions: Difference between revisions

ListActions

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

@@ Line 1: / Line 1: @@
-<message>Write the content here to display this box</message>
+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 is method that 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 ====
-{| class="wikitable"
+<syntaxhighlight>
-!OCL
+selfVM.ListActions(<nameofNesting>)
-!
+</syntaxhighlight>
-|-
-|selfVM.ListActions(<nameofNesting>)
-|Returns all available actions of Nesting
-|-
-|
-|
-|}
-'''Argument'''
-<code>nameofNesting</code>: String
+=== '''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.
+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'''
@@ Line 22: / Line 15: @@
 <code>Collection(ActionInstance)</code>
-==== '''ActionInstance Attributes''' ====
+List of the Action objects
-'''ActionName: String'''
+=== '''ActionInstance Attributes''' ===
+'''<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'''
+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.
-'''Hint: String'''
+'''<code>IsNavigating</code>: Boolean'''
-IsNavigating: Boolean
+true if action navigates to another ViewModel
-'''NestingName: String'''
+'''<code>NestingName</code>: String'''
 Name of ViewModel Nesting
-'''Presentation: String'''
+'''<code>Presentation</code>: String'''
 String representation of ViewModel
+==== See also: ====
+* [[Documentation:SelfVM|SelfVM]]
+* [[Documentation:Nestings|Nestings]]