Repository.Action.AddAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(10 intermediate revisions by the same user not shown)
Line 1: Line 1:
<noinclude>{{Template:API}}{{Template:APIBreadcrumb|10|Repository}}</noinclude>
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}
 
 
<onlyinclude>Adds a new action to the current project. The action description or name must be unique. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
 


Saves a new [[CAction Class|cAction]] object to the Synthesis repository. Returns a '''Boolean''' value; when true, indicates that the action now exists in the repository.
<noinclude>
== Syntax ==
== Syntax ==
''object''.'''Action.AddAction(''action'')'''
'''.Action.AddAction'''(''action'')
 
where ''object'' is a variable that represents a Repository object.


=== Parameters ===
=== Parameters ===
{| {{APITable}}
''action''
|-
:Required. The [[CAction Class|cAction]] object that represents the action resource to be added.
|action{{APIParam|Required}}||The [[CAction Class|cAction]] object to be added.
|}




== Example ==
== Example ==
This example creates a new action resource, and then saves it in the first available project in a Synthesis repository.
  '''VBA'''
  '''VBA'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
 
  {{APIComment|'Create a new action. The following example creates an action with the description "MyNewAction."}}
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction
  NewAction.ActionDescription = {{APIString|"MyNewAction"}}
   
   
{{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}
  {{APIComment|'Add the new action to project #1.}}
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction
  MyRepository.Project.SetCurrentProject(1)   
  NewAction.Name = {{APIString|"MyNewAction"}}
  {{APIPrefix|Call}} MyRepository.Action.AddAction(NewAction)
  {{APIComment|'Add the new action to project #1. The action will be visible in the Synthesis repository upon refresh.}}
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Call}} MyRepository.Action.AddAction(NewAction)


  '''VB.NET'''
  '''VB.NET'''
   
   
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
{{APIComment|...'Add code to connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
  {{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}
 
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction ({{APIString|"MyNewAction"}})
  {{APIComment|'Create a new action. The following example creates an action with the description "MyNewAction."}}
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction ({{APIString|"MyNewAction"}})
   
   
  {{APIComment|'Add the new action to project #1. The action will be visible in the Synthesis repository upon refresh.}}
  {{APIComment|'Add the new action to project #1.}}
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Action.AddAction(NewAction)
  MyRepository.Action.AddAction(NewAction)
</noinclude>

Latest revision as of 15:34, 9 June 2016

APIWiki.png


Member of: SynthesisAPI.Repository


Adds a new action to the current project. The action description or name must be unique. Returns a Boolean value; when true, indicates a successful save.


Syntax

.Action.AddAction(action)

Parameters

action

Required. The cAction object that represents the action resource to be added.


Example

This example creates a new action resource, and then saves it in the first available project in a Synthesis repository. 

VBA

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new action. The following example creates an action with the description "MyNewAction." 
  Dim NewAction As New cAction
  NewAction.ActionDescription = "MyNewAction"

 'Add the new action to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  Call MyRepository.Action.AddAction(NewAction)

VB.NET

 'Declare a new Repository object and connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  MyRepository.ConnectToAccessRepository("C:\RSRepository1.rsr10")
 
 'Create a new action. The following example creates an action with the description "MyNewAction." 
  Dim NewAction As New cAction ("MyNewAction")

 'Add the new action to project #1. 
  MyRepository.Project.SetCurrentProject(1)   
  MyRepository.Action.AddAction(NewAction)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.AddAction&oldid=64243"