Click or drag to resize

OpenProjectArgs Class

This argument object contains all parameters for the OpenProject(OpenProjectArgs) method
Inheritance Hierarchy

Namespace:  Articy.Api
Assembly:  ArticyApp (in ArticyApp.dll) Version: 1.0.0
public class OpenProjectArgs : ComplexApiCallArgs

The OpenProjectArgs type exposes the following members.

Public propertyCleanCheckout
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.
Public propertyForceProjectFolder
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.
Public propertyOpenExclusively
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.
Public propertyProjectFolder
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.
Public propertyProjectGuid
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
Public propertyScmPassword
The password of the Subversion/Perforce account that is to be used for opening this project.
Public propertyScmUsername
The username of the Subversion/Perforce account that is to be used for opening this project.
See Also