Repository.Model.UpdateModel: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}


Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
 
<onlyinclude>Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>


This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.
<noinclude>
 
== Syntax ==
== Syntax ==
  '''.Model.UpdateModel'''(''m'')
  '''.Model.UpdateModel'''(''m'')
Line 48: Line 49:
  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
  {{APIComment|'Apply the update to the model. Changes will be reflected in the repository.}}
   MyRepository.Model.UpdateModel(AModel)
   MyRepository.Model.UpdateModel(AModel)
</noinclude>

Revision as of 22:12, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Updates the properties of an existing model in the current project. Changes are reflected in the repository immediately upon refresh. Returns a Boolean value; when true, indicates a successful update.

This method does not affect published models, which are model resources that have been published from and are associated with an existing analysis/data source.

Syntax

.Model.UpdateModel(m)

Parameters

m

The cModel object to be updated.


Example

This example assumes that a model with ID#47 exists in the first available project of a repository.

VBA

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

 'Get model #47 from project #1. 
 Dim AModel As cModel
 MyRepository.Project.SetCurrentProject(1)  
 Set AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
 AModel.Name = "New_Name"

 'Apply the update to the model. Changes will be reflected in the repository. 
 Call MyRepository.Model.UpdateModel(AModel)
VB.NET

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

  'Get model #47 from project #1. 
 Dim AModel As cModel
 MyRepository.Project.SetCurrentProject(1)  
 AModel = MyRepository.Model.GetModel(47)

 'Change the model's name to "New_Name." 
 AModel.Name = "New_Name"

 'Apply the update to the model. Changes will be reflected in the repository. 
 MyRepository.Model.UpdateModel(AModel)