Project Object

The Project object provides a basic set of propeties and methods for scripting project maintenance tasks.

The ProjectManager and DeploymentManager objects extend the capabilities of the Project object. For more information, see "ProjectManager Object" and "DeploymentManager Object".

Properties

ActiveProjectFile

Syntax

ActiveProjectFile (read-only) 

Description

Filename of the active project or empty string if no project is open.

Methods

AddFileToProject

Syntax

AddFileToProject(const wsFilename: WideString): WordBool; 

Description

Boolean. Adds the passed file to the active project. The main project folder or a subfolder of the main project must contain the file.

CloseProject

Syntax

CloseProject(wbCloseOpenFiles: WordBool): WordBool; 

Description

Boolean. Closes the active project, if any. If wbCloseOpenFiles is True, then all open files are closed.

OpenProject

Syntax

OpenProject(const wsProjectFile: WideString): WordBool; 

Description

Boolean. Opens the passed project file, making it the active project. Pass an empty string to display the Open Project dialog box.

RemoveFileFromProject

Syntax

RemoveFileFromProject(const wsFilename: WideString): WordBool; 

Description

Boolean. Removes the passed file from the active project.

ShowLastProjectError

Syntax

ShowLastProjectError(); 

Description

Displays an error message for the last project-related error.

UploadProjectDlg

Syntax

UploadProjectDlg(): WordBool; 

Description

Boolean. Displays the upload project dialog box for the active project.

UploadProject

Syntax

UploadProject(const wsTargetDir: WideString; const wbForceLCase, wbUp-loadOnlyNewer, wbEncryptCFML: WordBool): WordBool; 

Description

Boolean. Uploads a project based on the passed criteria. The wbEncryptCFML parameter is specific to ColdFusion Studio.

Comments