Repository.Control.GetAllXfmeaControlsDictionary: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
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 XfmeaControls from the current project. The keys are the IDs of the controls.


== Syntax==
 
*GetAllXfmeaControlsDictionary() {{APIPrefix|As}} Dictionary(Of Integer, cXfmeaControl)
<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>
 
== Syntax ==
'''.Control.GetAllXfmeaControlsDictionary()'''
 
 
== Example ==
'''VB.NET'''
{{APIComment|'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  {{APIComment|...}}
{{APIComment|'Get a dictionary of all Xfmea controls in project #1.}}
  {{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl
  MyRepository.Project.SetCurrentProject(1) 
  ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
{{APIComment|'Output sample: Display the number of available Xfmea controls in the project. }}
  MsgBox(ControlsDict.Count)

Revision as of 18:11, 21 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


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.

Syntax

.Control.GetAllXfmeaControlsDictionary()


Example

VB.NET 

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


 '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 available Xfmea controls in the project.  
 MsgBox(ControlsDict.Count)