Repository.Action.AddAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
 
(7 intermediate revisions by the same user not shown)
Line 1: Line 1:
{{Template:API}}{{Template:APIBreadcrumb|10|.[[Repository Class|Repository]]}}
{{Template:API}}{{Template:APIBreadcrumb|.[[Repository Class|Repository]]}}




<onlyinclude>Saves a new [[CAction Class|cAction]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.</onlyinclude>  
<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>  


If an action with the same name already exists in the current project, the application will automatically increment the name. For example, if "Action1" already exists, the new action might be renamed to "Action2," "Action3," etc.


== Syntax ==
== Syntax ==
Line 11: Line 10:
=== Parameters ===
=== Parameters ===
''action''
''action''
:The [[CAction Class|cAction]] object to be added. (Required)
:Required. The [[CAction Class|cAction]] object that represents the action resource to be added.




Line 18: 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|'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|'Add the new action to project #1.}}
{{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}
  MyRepository.Project.SetCurrentProject(1)   
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction
  {{APIPrefix|Call}} MyRepository.Action.AddAction(NewAction)
  NewAction.Name = {{APIString|"MyNewAction"}}
  {{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'''
   
   
  {{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|'Create a new action. The following example creates an action with the description "MyNewAction."}}
  {{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction ({{APIString|"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)

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)