ListActions
No edit summary
No edit summary
 
(4 intermediate revisions by one other user not shown)
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.
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''' ====
==== OCL Expression ====
<syntaxhighlight>
<syntaxhighlight>
selfVM.ListActions(<nameofNesting>)
selfVM.ListActions(<nameofNesting>)
</syntaxhighlight>'''Argument'''
</syntaxhighlight>


<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'''
'''Return Type'''
Line 16: Line 17:
List of the Action objects
List of the Action objects


==== '''ActionInstance Attributes''' ====
=== '''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'''


'''Hint: String'''
Name of menu group for action


IsNavigating: Boolean
'''<code>Hint</code>: String'''


'''NestingName: 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
Name of ViewModel Nesting


'''Presentation: String'''  
'''<code>Presentation</code>: String'''  


String representation of ViewModel
String representation of ViewModel

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

See also:

This page was edited 1 days ago on 09/19/2024. What links here