Repository.Action.AddAction: Difference between revisions

From ReliaWiki
Jump to navigation Jump to search
No edit summary
No edit summary
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 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.  
 
Saves a new [[CAction Class|cAction]] object to the current project. Returns a '''Boolean''' value; when true, indicates a successful save.  
<noinclude>
<noinclude>
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 ==
''object''.'''Action.AddAction(''action'')'''
'''.Action.AddAction'''(''action'')
 
where ''object'' is a variable that represents a Repository object.
 
=== Parameters ===
=== Parameters ===
{| {{APITable}}
''action''
|-
:The [[CAction Class|cAction]] object to be added. (Required)
|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|'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|'Create a new action. The following example creates an action named "MyNewAction."}}
  {{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}
Line 31: Line 31:
  '''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|'Create a new action. The following example creates an action named "MyNewAction."}}
  {{APIComment|'Create a new action. The following example creates an action named "MyNewAction."}}

Revision as of 18:52, 20 July 2015

APIWiki.png


Member of: SynthesisAPI10.Repository


Saves a new cAction object to the current project. Returns a Boolean value; when true, indicates a successful save.

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

.Action.AddAction(action)

Parameters

action

The cAction object to be added. (Required)


Example

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

VBA

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 'Create a new action. The following example creates an action named "MyNewAction." 
 Dim NewAction As New cAction
 NewAction.Name = "MyNewAction"

 'Add the new action to project #1. The action will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 Call MyRepository.Action.AddAction(NewAction)
VB.NET

 'Add code to connect to a Synthesis repository. 
  Dim MyRepository As New Repository
  ... 


 'Create a new action. The following example creates an action named "MyNewAction." 
 Dim NewAction As New cAction ("MyNewAction")

 'Add the new action to project #1. The action will be visible in the Synthesis repository upon refresh. 
 MyRepository.Project.SetCurrentProject(1)   
 MyRepository.Action.AddAction(NewAction)