Repository.Xfmea.UpdateItemInSystemHierarchy Method - Revision history

Kate Racaza at 18:47, 9 June 2016

2016-06-09T18:47:01Z

← Older revision		Revision as of 18:47, 9 June 2016
Line 2:		Line 2:


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

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''item''		''item''
	:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated.		:Required. The [[XfmeaItem Class\|XfmeaItem]] object that represents the system hierarchy item to be updated.

Kate Racaza at 18:47, 8 April 2016

2016-04-08T18:47:25Z

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


	<onlyinclude>~~Applies~~ any changes made to an existing system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing system hierarchy item 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 a list of all items in the system hierarchy in project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the first item's name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	ListofItems(0).Nm = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the item. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))		{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

	'''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 a list of all items in the system hierarchy in project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the first item's name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	ListofItems(0).Nm = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the item. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))		MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

Kate Racaza at 22:26, 13 November 2015

2015-11-13T22:26:43Z

← Older revision		Revision as of 22:26, 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 22:47, 11 September 2015

2015-09-11T22:47:20Z

← Older revision		Revision as of 22:47, 11 September 2015
Line 2:		Line 2:


	<onlyinclude>Applies any changes made to an existing ~~Xfmea~~ system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Applies any changes made to an existing system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 11:		Line 11:
	:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated.		:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated.

	~~<!--~~
	== Example ==		== Example ==
	This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.		This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.
Line 22:		Line 22:


	{{APIComment\|'Get the ~~item with record ID #1 from~~ project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ~~MyItem~~ {{APIPrefix\|As}} XfmeaItem		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	~~{{APIPrefix\|Set}} MyItem~~ = MyRepository.Xfmea.~~GetItemInSystemHierarchy~~(1)		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the item's name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	~~MyItem~~.Nm = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}		{{APIComment\|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(~~MyItem~~)		{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

	'''VB.NET'''		'''VB.NET'''
Line 40:		Line 40:


	{{APIComment\|'Get ~~control #1 from~~ project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ~~MyControl~~ {{APIPrefix\|As}} ~~cXfmeaControl~~		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	~~MyControl~~ = MyRepository.~~Control~~.~~GetXfmeaControl~~(1)		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the ~~control~~'s name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	~~MyControl~~.~~Name~~ = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the change to the ~~control~~. Changes are recorded in the Synthesis repository.}}		{{APIComment\|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
	MyRepository.~~Control~~.~~UpdateXfmeaControl~~(~~MyControl~~)		MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))
	~~-->~~

Kate Racaza at 22:10, 24 August 2015

2015-08-24T22:10:55Z

← Older revision		Revision as of 22:10, 24 August 2015
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''item''		''item''
	:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated. ~~(Required)~~		:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated.

	<!--		<!--

Kate Racaza at 21:10, 24 August 2015

2015-08-24T21:10:03Z

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


	<onlyinclude>~~Updates the properties of~~ an existing system hierarchy item ~~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 Xfmea system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>

	== Syntax ==		== Syntax ==
Line 9:		Line 9:
	=== Parameters ===		=== Parameters ===
	''item''		''item''
	:The [[XfmeaItem Class\|XfmeaItem]] object to be updated. (Required)		:Required. The [[XfmeaItem Class\|XfmeaItem]] object to be updated. (Required)

	<!--		<!--
	== Example ==		== Example ==
	This example assumes that a system hierarchy item with record ID#1 exists in the repository.		This example assumes that a system hierarchy item with record ID #1 exists in the first available project in a repository.

	'''VBA'''		'''VBA'''
Line 30:		Line 30:
	MyItem.Nm = {{APIString\|"New_Name"}}		MyItem.Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'Apply the ~~update~~ to the item. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the item. Changes are recorded in the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(MyItem)		{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(MyItem)

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

	{{APIComment\|'Apply the ~~update~~ to the control. Changes ~~will be reflected~~ in the repository.}}		{{APIComment\|'Apply the change to the control. Changes are recorded in the Synthesis repository.}}
	MyRepository.Control.UpdateXfmeaControl(MyControl)		MyRepository.Control.UpdateXfmeaControl(MyControl)
	-->		-->

Kate Racaza: Created page with '{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} Updates the properties of an existing system hierarchy item in the current project. …'

2015-07-21T23:53:37Z

Created page with '{{Template:API}}{{Template:APIBreadcrumb|10|.Repository}} <onlyinclude>Updates the properties of an existing system hierarchy item in the current project. …'

New page

{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}

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

== Syntax ==
'''.Xfmea.UpdateItemInSystemHierarchy'''(''item'')

=== Parameters ===
''item''
:The [[XfmeaItem Class|XfmeaItem]] object to be updated. (Required)

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


	<onlyinclude>~~Applies~~ any changes made to an existing system hierarchy item. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>		<onlyinclude>Sends any changes made to an existing system hierarchy item 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 a list of all items in the system hierarchy in project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the first item's name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	ListofItems(0).Nm = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the item. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))		{{APIPrefix\|Call}} MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))

	'''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 a list of all items in the system hierarchy in project #1.}}		{{APIComment\|'Get a list of all items in the system hierarchy in project #1.}}
	{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem		{{APIPrefix\|Dim}} ListofItems() {{APIPrefix\|As}} XfmeaItem
	MyRepository.Project.SetCurrentProject(1)		MyRepository.Project.SetCurrentProject(1)
	ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()		ListofItems = MyRepository.Xfmea.GetAllItemsInSystemHierarchy()

	{{APIComment\|'Change the first item's name to "New_Name."}}		{{APIComment\|'Change the first item's name to "New_Name."}}
	ListofItems(0).Nm = {{APIString\|"New_Name"}}		ListofItems(0).Nm = {{APIString\|"New_Name"}}

	{{APIComment\|'~~Apply~~ the change to ~~the item. Changes are recorded in~~ the Synthesis repository.}}		{{APIComment\|'Send the change to the Synthesis repository.}}
	MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))		MyRepository.Xfmea.UpdateItemInSystemHierarchy(ListofItems(0))