Repository.Model.IsModelUsed - Revision history

Kate Racaza at 18:57, 8 April 2016

2016-04-08T18:57:59Z

← Older revision		Revision as of 18:57, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>Checks whether the model ~~with the designated ID number~~ is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>		<onlyinclude>Checks whether the model is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 16:		Line 16:
	'''VBA\|VB.NET'''		'''VBA\|VB.NET'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Check whether model #42 from project #1 is in use.}}		{{APIComment\|'Check whether model #42 from project #1 is in use.}}
	{{APIPrefix\|Dim}} CheckModel {{APIPrefix\|As Boolean}}		{{APIPrefix\|Dim}} CheckModel {{APIPrefix\|As Boolean}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	CheckModel = MyRepository.Model.IsModelUsed(42)		CheckModel = MyRepository.Model.IsModelUsed(42)

	{{APIComment\|'Output sample.}}		{{APIComment\|'Output sample.}}
	{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}		{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}
	MsgBox ({{APIString\|"The model is in use."}})		MsgBox ({{APIString\|"The model is in use."}})
	{{APIPrefix\|Else}}		{{APIPrefix\|Else}}
	MsgBox ({{APIString\|"The model is not in use."}})		MsgBox ({{APIString\|"The model is not in use."}})
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}

Kate Racaza at 22:16, 13 November 2015

2015-11-13T22:16:14Z

← Older revision		Revision as of 22:16, 13 November 2015
Line 1:		Line 1:
	{{Template:API}}{{Template:APIBreadcrumb~~\|10~~\|.[[Repository Class\|Repository]]}}		{{Template:API}}{{Template:APIBreadcrumb\|.[[Repository Class\|Repository]]}}

Kate Racaza at 23:43, 24 August 2015

2015-08-24T23:43:19Z

← Older revision		Revision as of 23:43, 24 August 2015
Line 2:		Line 2:


	<onlyinclude>Checks whether the model with the ID number ~~that you specify~~ is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>		<onlyinclude>Checks whether the model with the designated ID number is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>

	== Syntax ==		== Syntax ==
	'''.Model.IsModelUsed'''(''ID'')		'''.Model.IsModelUsed'''(''ID'')

	=== Parameters ===		=== Parameters ===
	''ID''		''ID''
	:Integer. The ID number of the model to be checked.		:Required. Integer. The ID number of the model to be checked.


	== Example ==		== Example ==
	This example assumes that a model with ID# 42 exists in the first available project in a repository.		This example assumes that a model with ID #42 exists in the first available project of a Synthesis repository.
	'''VBA\|VB.NET'''		'''VBA\|VB.NET'''

Line 21:		Line 22:

	{{APIComment\|'Check whether model #42 from project #1 is in use.}}		{{APIComment\|'Check whether model #42 from project #1 is in use.}}
			{{APIPrefix\|Dim}} CheckModel {{APIPrefix\|As Boolean}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)

	~~Dim CheckModel As Boolean~~
	CheckModel = MyRepository.Model.IsModelUsed(42)		CheckModel = MyRepository.Model.IsModelUsed(42)

	{{APIComment\|'Output sample:}}		{{APIComment\|'Output sample.}}
	{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}		{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}
	MsgBox ({{APIString\|"The model is in use."}})		MsgBox ({{APIString\|"The model is in use."}})

Kate Racaza at 22:13, 20 July 2015

2015-07-20T22:13:12Z

← Older revision		Revision as of 22:13, 20 July 2015
Line 1:		Line 1:
	~~<noinclude>~~{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}~~</noinclude>~~		{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}


	Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.		<onlyinclude>Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>
	<~~noinclude~~>
	== Syntax ==		== Syntax ==
	'''.Model.IsModelUsed'''(''ID'')		'''.Model.IsModelUsed'''(''ID'')
Line 32:		Line 32:
	MsgBox ({{APIString\|"The model is not in use."}})		MsgBox ({{APIString\|"The model is not in use."}})
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}
	~~</noinclude>~~

Kate Racaza at 20:53, 20 July 2015

2015-07-20T20:53:27Z

← Older revision		Revision as of 20:53, 20 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|.[[Repository Class\|Repository]]}}</noinclude>


	Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.		Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.
	<noinclude>		<noinclude>
	== Syntax ==		== Syntax ==
	'~~'object~~''.'''~~Model.IsModelUsed~~(''ID'')~~'''~~		'''.Model.IsModelUsed'''(''ID'')

	~~where ''object'' is a variable that represents a Repository object.~~

	=== Parameters ===		=== Parameters ===
	~~{\| {{APITable}}~~		''ID''
	\|-		:Integer. The ID number of the model to be checked.
	\|ID~~{{APIParam\|Required}}\|\|'~~''Integer~~'''~~. The ID number of the model to be checked.
	\|}


	== Example ==		== Example ==
	This example assumes that a model with ID# 42 exists in the repository.		This example assumes that a model with ID# 42 exists in the first available project in a repository.
	'''VBA\|VB.NET'''~~<br>~~		'''VBA\|VB.NET'''

			{{APIComment\|'Add code to connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{APIComment\|..~~.'Add code to connect to a Synthesis repository~~.}}		{{APIComment\|...}}


	{{APIComment\|'Check whether model #42 in project #1 is in use.}}		{{APIComment\|'Check whether model #42 from project #1 is in use.}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)

Kate Racaza at 17:27, 17 July 2015

2015-07-17T17:27:50Z

← Older revision		Revision as of 17:27, 17 July 2015
Line 1:		Line 1:
	<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|[[Repository Class\|Repository]]}}</noinclude>

	Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.		Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.

Kate Racaza at 15:00, 17 July 2015

2015-07-17T15:00:56Z

← Older revision		Revision as of 15:00, 17 July 2015
Line 1:		Line 1:
	{{Template:APIBreadcrumb\|10\|Repository}}		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>
	~~{{Template:API}}~~
	Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.		Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.
			<noinclude>
	== Syntax ==		== Syntax ==
	''object''.'''Model.IsModelUsed(''ID'')'''		''object''.'''Model.IsModelUsed(''ID'')'''
Line 33:		Line 33:
	MsgBox ({{APIString\|"The model is not in use."}})		MsgBox ({{APIString\|"The model is not in use."}})
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}
			</noinclude>

Kate Racaza at 15:44, 14 July 2015

2015-07-14T15:44:33Z

← Older revision		Revision as of 15:44, 14 July 2015
Line 1:		Line 1:
	{{Template:~~APIClass~~\|~~Repository Class~~\|Repository}}		{{Template:APIBreadcrumb\|10\|Repository}}
	{{Template:~~Repository~~.~~IsModelUsed~~.~~Cmt}}~~		{{Template:API}}
			Checks whether the model with the ID number that you specify is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.

	== Syntax==		== Syntax ==
	IsModelUsed(~~{{APIPrefix\|ByVal}}~~ ID ~~{{APIPrefix\|As Integer}}~~) ~~{{APIPrefix\|As Boolean}}~~		''object''.'''Model.IsModelUsed(''ID'')'''

	~~Parameters~~		where ''object'' is a variable that represents a Repository object.
	:''ID''~~: The ID~~ that ~~will have its use checked~~.

	== ~~Usage Example~~ ==		=== Parameters ===
	{{~~APIComment\|'Declare a new repository connection object.~~}}		{\| {{APITable}}
	~~Dim MyRepository As New Repository~~		\|-
			\|ID{{APIParam\|Required}}\|\|'''Integer'''. The ID number of the model to be checked.
	{{~~APIComment~~\|'~~Connect~~ to the ~~Synthesis~~ repository.}}		\|}
	Dim ~~Success~~ As ~~Boolean = False~~
	~~Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")~~
			== Example ==
	{{APIComment\|'~~Set~~ a ~~first available project as current~~.}}		This example assumes that a model with ID# 42 exists in the repository.
	~~MyRepository.Project.SetCurrentProject(0)~~		'''VBA\|VB.NET'''<br>
			{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...'Add code to connect to a Synthesis repository.}}

	{{APIComment\|'~~Get the list of models~~ in ~~the current~~ project.}}		{{APIComment\|'Check whether model #42 in project #1 is in use.}}
	~~Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]~~		MyRepository.Project.SetCurrentProject(1)
	~~ListOfModels =~~ MyRepository.~~Model~~.~~GetAllModelsInfo~~()

	~~{{APIComment\|'Retrieve the model with ID = 20.}}~~
	~~Dim AModel as cModel~~
	~~AModel = MyRepository.Model.GetModel(20)~~

	~~{{APIComment\|'Change the model's name.}}~~		Dim CheckModel As Boolean
	~~AModel.Name = "New Name"~~		CheckModel = MyRepository.Model.IsModelUsed(42)

	~~{{APIComment\|'Update the model in the repository.}}~~
	Dim ~~SuccessUpdateModel~~ As Boolean
	~~SuccessUpdateModel~~ = MyRepository.Model.~~UpdateModel~~(20)

	{{APIComment\|'~~Check to see if Model 20 is being used.~~}}		{{APIComment\|'Output sample:}}
	~~Dim SucessIsModelUsed As Boolean~~		{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}
	~~SucessIsModelUsed = MyRepository~~.~~Model.IsModelUsed (20~~)		MsgBox ({{APIString\|"The model is in use."}})
			{{APIPrefix\|Else}}
	{{~~APIComment~~\|~~'Disconnect from the repository~~.}}		MsgBox ({{APIString\|"The model is not in use."}})
	~~MyRepository.DisconnectFromRepository~~		{{APIPrefix\|End If}}

Alex Ulanov: /* Usage Example */

2015-05-22T20:27:40Z

Usage Example

← Older revision		Revision as of 20:27, 22 May 2015
Line 15:		Line 15:
	Dim Success As Boolean = False		Dim Success As Boolean = False
	Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")		Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")

	{{APIComment\|'Get the list of models in the ~~connected repository~~.}}		{{APIComment\|'Set a first available project as current.}}
			MyRepository.Project.SetCurrentProject(0)

			{{APIComment\|'Get the list of models in the current project.}}
	Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]		Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]
	ListOfModels = MyRepository.Model.GetAllModelsInfo()		ListOfModels = MyRepository.Model.GetAllModelsInfo()

Alex Ulanov: /* Usage Example */

2015-05-22T16:29:54Z

Usage Example

← Older revision		Revision as of 16:29, 22 May 2015
Line 18:		Line 18:
	{{APIComment\|'Get the list of models in the connected repository.}}		{{APIComment\|'Get the list of models in the connected repository.}}
	Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]		Dim ListOfModels() As [[NameIdPair Class\|NameIdPair]]
	ListOfModels = MyRepository.GetAllModelsInfo()		ListOfModels = MyRepository.Model.GetAllModelsInfo()

	{{APIComment\|'Retrieve the model with ID = 20.}}		{{APIComment\|'Retrieve the model with ID = 20.}}
	Dim AModel as cModel		Dim AModel as cModel
	AModel = MyRepository.GetModel(20)		AModel = MyRepository.Model.GetModel(20)

	{{APIComment\|'Change the model's name.}}		{{APIComment\|'Change the model's name.}}
Line 29:		Line 29:
	{{APIComment\|'Update the model in the repository.}}		{{APIComment\|'Update the model in the repository.}}
	Dim SuccessUpdateModel As Boolean		Dim SuccessUpdateModel As Boolean
	SuccessUpdateModel = MyRepository.UpdateModel(20)		SuccessUpdateModel = MyRepository.Model.UpdateModel(20)

	{{APIComment\|'Check to see if Model 20 is being used.}}		{{APIComment\|'Check to see if Model 20 is being used.}}
	Dim SucessIsModelUsed As Boolean		Dim SucessIsModelUsed As Boolean
	SucessIsModelUsed = MyRepository.IsModelUsed (20)		SucessIsModelUsed = MyRepository.Model.IsModelUsed (20)

	{{APIComment\|'Disconnect from the repository.}}		{{APIComment\|'Disconnect from the repository.}}
	MyRepository.DisconnectFromRepository		MyRepository.DisconnectFromRepository

← Older revision		Revision as of 18:57, 8 April 2016
Line 2:		Line 2:


	<onlyinclude>Checks whether the model ~~with the designated ID number~~ is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>		<onlyinclude>Checks whether the model is used by other items in the project. Returns a '''Boolean''' value; when true, indicates that the model is in use.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 16:		Line 16:
	'''VBA\|VB.NET'''		'''VBA\|VB.NET'''

	{{APIComment\|'~~Add code to~~ connect to a Synthesis repository.}}		{{APIComment\|'Declare a new Repository object and connect to a Synthesis repository.}}
	{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
	{{~~APIComment~~\|...}}		MyRepository.ConnectToAccessRepository({{APIString\|"C:\RSRepository1.rsr10"}})


	{{APIComment\|'Check whether model #42 from project #1 is in use.}}		{{APIComment\|'Check whether model #42 from project #1 is in use.}}
	{{APIPrefix\|Dim}} CheckModel {{APIPrefix\|As Boolean}}		{{APIPrefix\|Dim}} CheckModel {{APIPrefix\|As Boolean}}
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	CheckModel = MyRepository.Model.IsModelUsed(42)		CheckModel = MyRepository.Model.IsModelUsed(42)

	{{APIComment\|'Output sample.}}		{{APIComment\|'Output sample.}}
	{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}		{{APIPrefix\|If}} CheckModel = {{APIPrefix\|True Then}}
	MsgBox ({{APIString\|"The model is in use."}})		MsgBox ({{APIString\|"The model is in use."}})
	{{APIPrefix\|Else}}		{{APIPrefix\|Else}}
	MsgBox ({{APIString\|"The model is not in use."}})		MsgBox ({{APIString\|"The model is not in use."}})
	{{APIPrefix\|End If}}		{{APIPrefix\|End If}}