Repository.Action.GetAllActionsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
Line 1: Line 1:
{{Template:APIClass|Repository Class|Repository}}
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
Returns a dictionary containing all actions in the current project. The keys are the Ids of the actions.


== Syntax==
*GetAllActionsDictionary() {{APIPrefix|As}} Dictionary(Of Integer, [[cAction Class|cAction]])


== Usage Example ==
<onlyinclude>Gets a dictionary of all existing actions in the current project. Returns a '''Dictionary(Of Integer, cAction)''' object, where the keys are the ID numbers of the actions.</onlyinclude>
<div style="margin-right: 150px;">
 
  {{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
'''.Action.GetAllActionsDictionary()'''
 
 
== Example ==
This example assumes that actions exist in the first available project of the repository.
  '''VB.NET'''
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  Dim Success As Boolean = False
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
   
   
{{APIComment|'Set a first available project as current.}}
  MyRepository.Project.SetCurrentProject(0)
    
    
  {{APIComment|'Get the dictionary of actions in the current project.}}
  {{APIComment|'Get a dictionary of all actions in project #1.}}
   Dim actions As Dictionary(Of Integer, cAction)
   {{APIPrefix|Dim}} ActionsDict {{APIPrefix|As}} Dictionary (of Integer, cAction)
   actions = MyRepository.Action.GetAllActionsDictionary()
  MyRepository.Project.SetCurrentProject(1) 
</div>
   ActionsDict = MyRepository.Action.GetAllActionsDictionary()
{{APIComment|'Output sample: Display the number of available actions in the project. }}
  MsgBox(ActionsDict.Count)

Revision as of 17:51, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Gets a dictionary of all existing actions in the current project. Returns a Dictionary(Of Integer, cAction) object, where the keys are the ID numbers of the actions.

Syntax

.Action.GetAllActionsDictionary()


Example

This example assumes that actions exist in the first available project of the repository. 

VB.NET 
 
 Dim MyRepository As New Repository
 ...'Add code to connect to a Synthesis repository.   

 
 'Get a dictionary of all actions in project #1. 
 Dim ActionsDict As Dictionary (of Integer, cAction)  
 MyRepository.Project.SetCurrentProject(1)  
 ActionsDict = MyRepository.Action.GetAllActionsDictionary()

 'Output sample: Display the number of available actions in the project.  
 MsgBox(ActionsDict.Count)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.GetAllActionsDictionary&oldid=59643"