Repository.Action.GetAllActionsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 2: Line 2:




<onlyinclude>Gets a dictionary of action resources associated with a project. Returns a '''Dictionary(Of Integer, [[CAction Class|cAction]])''' object, where the keys are the ID numbers of the actions. (VB.NET only)</onlyinclude>
<onlyinclude>Returns a dictionary object that contains the ID numbers as keys and the action resources as the associated values. The dictionary syntax is '''Dictionary(Of Integer, [[CAction Class|cAction]])'''. (VB.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 15: Line 15:
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
  {{APIComment|'Get a dictionary of all actions in project #1.}}
{{APIComment|'Set the first project in the repository as the current project.}}
   MyRepository.Project.SetCurrentProject(1) 
   
  {{APIComment|'Declare a new dictionary object.}}
   {{APIPrefix|Dim}} ActionsDict {{APIPrefix|As}} Dictionary (of Integer, cAction)   
   {{APIPrefix|Dim}} ActionsDict {{APIPrefix|As}} Dictionary (of Integer, cAction)   
  MyRepository.Project.SetCurrentProject(1) 
{{APIComment|'Add values to the dictionary.}}
   ActionsDict = MyRepository.Action.GetAllActionsDictionary()
   ActionsDict = MyRepository.Action.GetAllActionsDictionary()
   
   
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
   MsgBox(ActionsDict.Count)
   MsgBox(ActionsDict.Count)

Revision as of 16:35, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a dictionary object that contains the ID numbers as keys and the action resources as the associated values. The dictionary syntax is Dictionary(Of Integer, cAction). (VB.NET only)

Syntax

.Action.GetAllActionsDictionary()


Example

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

VB.NET 
 
 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")

 'Set the first project in the repository as the current project. 
  MyRepository.Project.SetCurrentProject(1)  
   
 'Declare a new dictionary object. 
  Dim ActionsDict As Dictionary (of Integer, cAction)  

 'Add values to the dictionary. 
  ActionsDict = MyRepository.Action.GetAllActionsDictionary()

 'Output sample: Display the number of entries in the dictionary. 
  MsgBox(ActionsDict.Count)