Repository.Control.GetAllXfmeaControlsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(8 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 Xfmea controls in the current project. Returns a '''Dictionary (Of Integer, cXfmeaControl)''' object, where the keys are the ID numbers of the controls.</onlyinclude>
<onlyinclude>Returns a dictionary object that contains all available Xfmea controls in the current project. The dictionary syntax is '''Dictionary (Of Integer, cXfmeaControl)''', where the ID numbers are the keys and the [[cXfmeaControl Class|cXfmeaControl]] objects that represent the controls are the associated values. (.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 9: Line 9:


== Example ==
== Example ==
This example assumes that Xfmea controls exist in the first available project of the repository.
  '''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|'Set the first project in the repository as the current project.}}
  MyRepository.Project.SetCurrentProject(1) 
 
{{APIComment|'Declare a new dictionary object.}}
  {{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl) 
   
   
  {{APIComment|'Get a dictionary of all Xfmea controls in project #1.}}
  {{APIComment|'Add values to the dictionary.}}
  {{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl) 
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
  MyRepository.Project.SetCurrentProject(1) 
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
   
   
  {{APIComment|'Output sample: Display the number of available Xfmea controls in the project. }}
  {{APIComment|'Output sample: Display the number of entries in the dictionary.}}
  MsgBox(ControlsDict.Count)
  MsgBox(ControlsDict.Count)

Latest revision as of 15:08, 3 August 2017

APIWiki.png


Member of: SynthesisAPI.Repository


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

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

 'Add values to the dictionary. 
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()

 'Output sample: Display the number of entries in the dictionary. 
  MsgBox(ControlsDict.Count)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Control.GetAllXfmeaControlsDictionary&oldid=65106"