Repository.Control.GetAllXfmeaControlsDictionary: Difference between revisions
Jump to navigation
Jump to search
Alex Ulanov (talk | contribs) (Created page with '{{Template:APIClass|Repository Class|Repository}} Returns a dictionary containing all XfmeaControls from the current project. The keys are the IDs of the controls. == Syntax== *…') |
Kate Racaza (talk | contribs) No edit summary |
||
| (10 intermediate revisions by 2 users not shown) | |||
| Line 1: | Line 1: | ||
{{Template: | {{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}} | ||
== Syntax== | |||
<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 == | |||
'''.Control.GetAllXfmeaControlsDictionary()''' | |||
== Example == | |||
This example assumes that Xfmea controls exist in the first available project of the repository. | |||
'''VB.NET''' | |||
{{APIComment|'Declare a new Repository object and 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.}} | |||
MyRepository.Project.SetCurrentProject(1) | |||
{{APIComment|'Declare a new dictionary object.}} | |||
{{APIPrefix|Dim}} ControlsDict {{APIPrefix|As}} Dictionary (of Integer, cXfmeaControl) | |||
{{APIComment|'Add values to the dictionary.}} | |||
ControlsDict = MyRepository.Control.GetAllXfmeaControlsDictionary() | |||
{{APIComment|'Output sample: Display the number of entries in the dictionary.}} | |||
MsgBox(ControlsDict.Count) | |||
Latest revision as of 15:08, 3 August 2017
 |
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)