Repository.Control.GetAllXfmeaControlsDictionary: Difference between revisions

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




<onlyinclude>Gets a dictionary of all existing Xfmea controls in the current project. Returns a '''Dictionary (Of Integer, [[cXfmeaControl Class|cXfmeaControl]])''' object, where the keys are the ID numbers of the controls. (VB.NET only)</onlyinclude>
<onlyinclude>Gets a dictionary of Xfmea controls associated with a project. Returns a '''Dictionary (Of Integer, [[cXfmeaControl Class|cXfmeaControl]])''' object, where the keys are the ID numbers of the controls. (VB.NET only)</onlyinclude>


== Syntax ==
== Syntax ==
Line 22: Line 22:
   ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
   ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary()
   
   
  {{APIComment|'Output sample: Display the number of available Xfmea controls in the project. }}
  {{APIComment|'Output sample: Display the number of available Xfmea controls associated with the project. }}
   MsgBox(ControlsDict.Count)
   MsgBox(ControlsDict.Count)

Revision as of 22:22, 24 August 2015

APIWiki.png


Member of: SynthesisAPI10.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 

 '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 associated with the project.  
 MsgBox(ControlsDict.Count)