Repository.Action.UpdateAction - Revision history

Kate Racaza at 15:40, 9 June 2016

2016-06-09T15:40:25Z

← Older revision		Revision as of 15:40, 9 June 2016
Line 2:		Line 2:


	<onlyinclude>~~Sends any changes made to an existing~~ action resource to the ~~Synthesis repository~~. Returns a '''Boolean''' value; when true, indicates a successful ~~save~~.</onlyinclude>		<onlyinclude>Updates the properties of a given action resource in the current project. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''action''		''action''
	:Required. The [[CAction Class\|cAction]] object to be updated.		:Required. The [[CAction Class\|cAction]] object that represents the action resource to be updated.

Kate Racaza at 18:33, 8 April 2016

2016-04-08T18:33:34Z

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


	<onlyinclude>~~Applies~~ any changes made to an existing action. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing action resource to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 17:		Line 17:
	'''VBA'''		'''VBA'''

	{{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\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}
	{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyAction = MyRepository.Action.GetAction(1)		{{APIPrefix\|Set}} MyAction = MyRepository.Action.GetAction(1)

	{{APIComment\|'Change the action's name to "New_Name."}}		{{APIComment\|'Change the action's name to "New_Name."}}
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the action. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)		{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)

	'''VB.NET'''		'''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\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}
	{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyAction = MyRepository.Action.GetAction(1)		MyAction = MyRepository.Action.GetAction(1)

	{{APIComment\|'Change the action's name to "New_Name."}}		{{APIComment\|'Change the action's name to "New_Name."}}
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the action. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Action.UpdateAction(MyAction)		MyRepository.Action.UpdateAction(MyAction)

Kate Racaza at 22:11, 13 November 2015

2015-11-13T22:11:56Z

← Older revision		Revision as of 22:11, 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 21:05, 24 August 2015

2015-08-24T21:05:47Z

← Older revision		Revision as of 21:05, 24 August 2015
Line 2:		Line 2:


	<onlyinclude>~~Updates the properties of~~ an existing action ~~in the current project. Changes are reflected in the repository immediately upon refresh~~. Returns a '''Boolean''' value; when true, indicates a successful ~~update~~.</onlyinclude>		<onlyinclude>Applies any changes made to an existing action. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''action''		''action''
	:The [[CAction Class\|cAction]] object to be updated.		:Required. The [[CAction Class\|cAction]] object to be updated.


	== Example ==		== Example ==
	This example assumes that an action with ID#1 exists in the repository.		This example assumes that an action with ID #1 exists in the first available project of a repository.

	'''VBA'''		'''VBA'''
Line 30:		Line 30:
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the action. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the action. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)		{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)

Line 48:		Line 48:
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the action. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the action. Changes are recorded in the Synthesis repository.}}
	MyRepository.Action.UpdateAction(MyAction)		MyRepository.Action.UpdateAction(MyAction)

Kate Racaza at 18:41, 21 July 2015

2015-07-21T18:41:43Z

← Older revision		Revision as of 18:41, 21 July 2015
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 action 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 action in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.</onlyinclude>
	~~<noinclude>~~
	== Syntax ==		== Syntax ==
	'''.Action.UpdateAction'''(''action'')		'''.Action.UpdateAction'''(''action'')

	=== Parameters ===		=== Parameters ===
	''action''		''action''
Line 49:		Line 50:
	{{APIComment\|'Apply the update to the action. Changes will be reflected in the repository.}}		{{APIComment\|'Apply the update to the action. Changes will be reflected in the repository.}}
	MyRepository.Action.UpdateAction(MyAction)		MyRepository.Action.UpdateAction(MyAction)
	~~</noinclude>~~

Kate Racaza at 17:53, 21 July 2015

2015-07-21T17:53:14Z

← Older revision		Revision as of 17:53, 21 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>


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

Kate Racaza at 20:31, 20 July 2015

2015-07-20T20:31:32Z

← Older revision		Revision as of 20:31, 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>

	~~Saves all updates to~~ an action. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Updates the properties of an existing action in the current project. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
	<noinclude>		<noinclude>
	== Syntax ==		== Syntax ==
	'~~'object~~''.'''~~Action.UpdateAction~~(''action'')~~'''~~		'''.Action.UpdateAction'''(''action'')

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

	=== Parameters ===		=== Parameters ===
	~~{\| {{APITable}}~~		''action''
	\|-		:The [[CAction Class\|cAction]] object to be updated.
	~~\|action{{APIParam\|Required}}\|\|~~The [[CAction Class\|cAction]] object to be updated.
	\|}


Line 20:		Line 15:
	'''VBA'''		'''VBA'''

	{{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~~.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


	{{APIComment\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}
Line 36:		Line 33:
	'''VB.NET'''		'''VB.NET'''

	{{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~~.}}		{{APIPrefix\|Dim}} MyRepository {{APIPrefix\|As New}} Repository
			{{APIComment\|...}}


	{{APIComment\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}

Kate Racaza at 17:23, 17 July 2015

2015-07-17T17:23:55Z

← Older revision		Revision as of 17:23, 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>

	Saves all updates to an action. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.		Saves all updates to an action. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.

Kate Racaza at 22:15, 16 July 2015

2015-07-16T22:15:30Z

← Older revision		Revision as of 22:15, 16 July 2015
Line 1:		Line 1:
	{{Template:~~APIClass\|Repository Class\|Repository~~}}		<noinclude>{{Template:API}}{{Template:APIBreadcrumb\|10\|Repository}}</noinclude>
	{{Template:Repository~~.UpdateAction.Cmt}} {{Template:BooleanReturn.Cmt~~}}

	==Syntax==		Saves all updates to an action. Changes are reflected in the repository immediately upon refresh. Returns a '''Boolean''' value; when true, indicates a successful update.
	*UpdateAction(~~ByVal~~ action ~~{{APIPrefix\|As}} [[cAction Class\|cAction]]~~ ) ~~{{APIPrefix\|As Boolean}}~~		<noinclude>
			== Syntax ==
			''object''.'''Action.UpdateAction(''action'')'''

	~~Parameters~~		where ''object'' is a variable that represents a Repository object.
	:''~~action~~''~~: The [[cAction Class\|cAction]] to update~~.

	== ~~Usage Example~~ ==		=== Parameters ===
	{{~~APIComment~~\|~~'Declare a new repository connection~~ object.}}		{\| {{APITable}}
	Dim MyRepository As New Repository		\|-
			\|action{{APIParam\|Required}}\|\|The [[CAction Class\|cAction]] object to be updated.
			\|}


			== Example ==
			This example assumes that an action with ID#1 exists in the repository.

			'''VBA'''

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

	{{APIComment\|'~~Connect to the Synthesis repository~~.}}		{{APIComment\|'Get action #1 from project #1.}}
	Dim ~~Success~~ As ~~Boolean = False~~		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
	~~Success~~ = MyRepository.~~ConnectToRepository~~("~~RepositoryFileNamePath~~")		MyRepository.Project.SetCurrentProject(1)
			{{APIPrefix\|Set}} MyAction = MyRepository.Action.GetAction(1)

			{{APIComment\|'Change the action's name to "New_Name."}}
			MyAction.Name = {{APIString\|"New_Name"}}

			{{APIComment\|'Apply the update to the action. Changes will be reflected in the repository.}}
			{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)

			'''VB.NET'''

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

	{{APIComment\|'~~Set a first available~~ project ~~as current~~.}}		{{APIComment\|'Get action #1 from project #1.}}
	MyRepository.Project.SetCurrentProject(0)		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
			MyRepository.Project.SetCurrentProject(1)
			MyAction = MyRepository.Action.GetAction(1)

	{{APIComment\|'~~Get~~ the ~~list of actions in the current project~~.}}		{{APIComment\|'Change the action's name to "New_Name."}}
	~~Dim ListOfActions() As [[cAction Class~~\|~~cAction]]~~		MyAction.Name = {{APIString\|"New_Name"}}
	~~ListOfActions= MyRepository.Action.GetAllActions()~~
			{{APIComment\|'Apply the update to the action. Changes will be reflected in the repository.}}
	{{APIComment\|'~~Update~~ the action ~~and update~~ the repository.}}		MyRepository.Action.UpdateAction(MyAction)
	~~Dim SuccessUpdateAction As Boolean~~		</noinclude>
	~~SuccessUpdateAction =~~ MyRepository.Action.UpdateAction(~~ListOfActions(0)~~)

Alex Ulanov at 21:03, 26 June 2015

2015-06-26T21:03:05Z

← Older revision		Revision as of 21:03, 26 June 2015
Line 3:		Line 3:

	==Syntax==		==Syntax==
	*UpdateAction( action {{APIPrefix\|As}} [[cAction Class\|cAction]] ) {{APIPrefix\|As Boolean}}		*UpdateAction(ByVal action {{APIPrefix\|As}} [[cAction Class\|cAction]] ) {{APIPrefix\|As Boolean}}

	Parameters		Parameters

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


	<onlyinclude>~~Applies~~ any changes made to an existing action. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing action resource to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 17:		Line 17:
	'''VBA'''		'''VBA'''

	{{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\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}
	{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	{{APIPrefix\|Set}} MyAction = MyRepository.Action.GetAction(1)		{{APIPrefix\|Set}} MyAction = MyRepository.Action.GetAction(1)

	{{APIComment\|'Change the action's name to "New_Name."}}		{{APIComment\|'Change the action's name to "New_Name."}}
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the action. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)		{{APIPrefix\|Call}} MyRepository.Action.UpdateAction(MyAction)

	'''VB.NET'''		'''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\|'Get action #1 from project #1.}}		{{APIComment\|'Get action #1 from project #1.}}
	{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction		{{APIPrefix\|Dim}} MyAction {{APIPrefix\|As}} cAction
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	MyAction = MyRepository.Action.GetAction(1)		MyAction = MyRepository.Action.GetAction(1)

	{{APIComment\|'Change the action's name to "New_Name."}}		{{APIComment\|'Change the action's name to "New_Name."}}
	MyAction.Name = {{APIString\|"New_Name"}}		MyAction.Name = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the action. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Action.UpdateAction(MyAction)		MyRepository.Action.UpdateAction(MyAction)