Repository.Action.GetAllActionsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(11 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<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>
<onlyinclude>Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is '''Dictionary(Of Integer, cAction)''', where the ID numbers are the keys and the [[CAction Class|cAction]] objects that represent the action resources are the associated values. (.NET only)</onlyinclude>


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

Latest revision as of 15:08, 3 August 2017

APIWiki.png


Member of: SynthesisAPI.Repository


Returns a dictionary object that contains all available action resources in the current project. The dictionary syntax is Dictionary(Of Integer, cAction), where the ID numbers are the keys and the cAction objects that represent the action resources are the associated values. (.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)