Repository.Action.AddAction: Difference between revisions

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


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


Parameters:
<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>
:''action'': An instance of [[cAction Class|cAction]] to add.


== Usage Example ==
 
  {{APIComment|'Declare a new repository connection object.}}
== Syntax ==
  Dim MyRepository As New Repository
'''.Action.AddAction'''(''action'')
 
=== Parameters ===
''action''
:Required. The [[CAction Class|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'''
  {{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Connect to the Synthesis repository.}}
  {{APIComment|'Create a new action. The following example creates an action with the description "MyNewAction."}}
  Dim Success As Boolean = False
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction
  Success = MyRepository.ConnectToRepository("RepositoryFileNamePath")
  NewAction.ActionDescription = {{APIString|"MyNewAction"}}
{{APIComment|'Add the new action to project #1.}}
  MyRepository.Project.SetCurrentProject(1) 
  {{APIPrefix|Call}} MyRepository.Action.AddAction(NewAction)
 
'''VB.NET'''
{{APIComment|'Declare a new Repository object and connect to a Synthesis repository.}}
  {{APIPrefix|Dim}} MyRepository {{APIPrefix|As New}} Repository
  MyRepository.ConnectToAccessRepository({{APIString|"C:\RSRepository1.rsr10"}})
    
    
  {{APIComment|'Set a first available project as current.}}
  {{APIComment|'Create a new action. The following example creates an action with the description "MyNewAction."}}
  MyRepository.Project.SetCurrentProject(0)
  {{APIPrefix|Dim}} NewAction {{APIPrefix|As New}} cAction ({{APIString|"MyNewAction"}})
   
   
{{APIComment|'Declare a new cAction.}}
  {{APIComment|'Add the new action to project #1.}}
  Dim newAction As New cAction("NewAction1")
  MyRepository.Project.SetCurrentProject(1)    
 
  MyRepository.Action.AddAction(NewAction)
  {{APIComment|'Add the new action to the repository.}}
   Dim SuccessAddAction As Boolean
  SuccessAddAction = 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)
Retrieved from "https://www.reliawiki.com/index.php?title=Repository.Action.AddAction&oldid=64243"