OpenProjectArgs Class
This argument object contains all parameters for the OpenProject(OpenProjectArgs) method
Definition
Namespace: Articy.Api
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
Assembly: ArticyApp (in ArticyApp.dll) Version: 1.0.0
C#
public class OpenProjectArgs : ComplexApiCallArgs- Inheritance
- Object ComplexApiCallArgs OpenProjectArgs
Constructors
| OpenProjectArgs | Initializes a new instance of the OpenProjectArgs class |
Properties
| CleanCheckout | Default false. When set to true opening the project copies the whole project data to the project folder regardless if it is needed or not. All data in the folder is deleted before the Project folder is used. You might want to make sure you have all necessary files locally before starting an extensive API operation. However this could take more time before the project is ready to be worked with. |
| ForceProjectFolder | Defaults to false. This causes the articy:draft API to use the project folder that was used the last time this project was opened by the current user/machine. This could have also been a GUI rather than an API session. If this property is set to true however, the project folder of the last opening session is ignored and the project data is copied to the folder specified by the ProjectFolder property in this class. |
| LogSourceName |
The "source" name that should be used when the action that receives the arguments wants to report
Progress or other logging output. You will encounter this name as "aMessageSource" within you logging callback
(Inherited from ComplexApiCallArgs) |
| OpenExclusively | If false the project is opened in normal mode, if true it is opened in exclusive mode. Implications are the same as when using the GUI of articy:draft. |
| ProjectFolder | This is the fully qualified name of the path articy:draft uses as local project folder. All Subersion/Perforce operations exchange data between this local folder and their repository/depot. When a project is opened for the very first time on a computer or with a specific user account a new project folder needs to be specified and the complete project data is download locally. |
| ProjectGuid | The Guid of the project to open. This guid can be found in the property sheet of the project node in articy:draft or you can use it from the enumeration method GetProjectList |
| ScmPassword | The password of the Subversion/Perforce account that is to be used for opening this project. |
| ScmUsername | The username of the Subversion/Perforce account that is to be used for opening this project. |
Methods
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| ToString | Returns a string that represents the current object. (Inherited from Object) |
Extension Methods
| TraceError | (Defined by TraceHelper) |
| TraceInfo | (Defined by TraceHelper) |
| TraceWarning | (Defined by TraceHelper) |