Repository.Model.GetAllModels: Difference between revisions
Jump to navigation
Jump to search
Kate Racaza (talk | contribs) No edit summary |
Kate Racaza (talk | contribs) No edit summary |
||
| Line 1: | Line 1: | ||
{{Template:APIBreadcrumb|10|Repository}} | {{Template:APIBreadcrumb|10|Repository}} | ||
{{Template:API}} | {{Template:API}} | ||
Gets a list of all existing local models in the current project (does not include global models). Returns a '''[[CModel Class|cModel]]''' object array that contains the model names, ID numbers and other information. | Gets a list of all existing local models in the current project (does not include global or reference models). Returns a '''[[CModel Class|cModel]]''' object array that contains the model names, ID numbers and other information. | ||
== Syntax == | == Syntax == | ||
| Line 9: | Line 9: | ||
== Example == | == Example == | ||
'''VBA|VB.NET''' | This example assumes that models exist in the first available project of a repository. | ||
'''VBA|VB.NET''' | |||
{{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository | ||
{{APIComment|...'Add code to connect to a Synthesis repository.}} | {{APIComment|...'Add code to connect to a Synthesis repository.}} | ||
{{APIComment| | |||
{{APIComment|'Get a list of all models in project #1.}} | |||
{{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel | {{APIPrefix|Dim}} ListofModels() {{APIPrefix|As}} cModel | ||
MyRepository.Project.SetCurrentProject (1) | |||
ListofModels = MyRepository.Model.GetAllModels() | ListofModels = MyRepository.Model.GetAllModels() | ||
{{APIComment|'Output sample: Display the name and ID of the first available model in the project.}} | |||
{{APIPrefix|Dim}} ModelName {{APIPrefix|As}} String | |||
{{APIPrefix|Dim}} ModelID {{APIPrefix|As}} Integer | |||
ModelName = ListofModels(0).Name | |||
ModelID = ListofModels(0).ID | |||
MsgBox ({{APIString|"The first model is: "}} & ModelName & {{APIString|", ID#"}} & ModelID) | |||
Revision as of 16:21, 14 July 2015
Member of: SynthesisAPI10Repository
 |
Gets a list of all existing local models in the current project (does not include global or reference models). Returns a cModel object array that contains the model names, ID numbers and other information.
Syntax
object.Model.GetAllModels()
where object is a variable that represents a Repository object.
Example
This example assumes that models exist in the first available project of a repository.
VBA|VB.NET Dim MyRepository As New Repository ...'Add code to connect to a Synthesis repository. 'Get a list of all models in project #1. Dim ListofModels() As cModel MyRepository.Project.SetCurrentProject (1) ListofModels = MyRepository.Model.GetAllModels() 'Output sample: Display the name and ID of the first available model in the project. Dim ModelName As String Dim ModelID As Integer ModelName = ListofModels(0).Name ModelID = ListofModels(0).ID MsgBox ("The first model is: " & ModelName & ", ID#" & ModelID)