Repository.Control.GetAllXfmeaControlsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
mNo edit summary
No edit summary
Line 12: Line 12:
  '''VB.NET'''  
  '''VB.NET'''  
   
   
  {{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
   {{APIComment|...}}
   MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Get a dictionary of all Xfmea controls in project #1.}}
  {{APIComment|'Get a dictionary of all Xfmea controls in project #1.}}
  {{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl)   
  {{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl)   
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
   
   
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
  MsgBox(ControlsDict.Count)
  MsgBox(ControlsDict.Count)

Revision as of 18:04, 8 April 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Gets a dictionary of Xfmea controls associated with a project. Returns a Dictionary (Of Integer, cXfmeaControl) object, where the keys are the ID numbers of the controls. (VB.NET only)

Syntax

.Control.GetAllXfmeaControlsDictionary()


Example

This example assumes that Xfmea controls 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")
 
 'Get a dictionary of all Xfmea controls in project #1. 
  Dim ControlsDict As Dictionary (of Integer, cXfmeaControl)  
  MyRepository.Project.SetCurrentProject(1)  
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()

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