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 (read-only)

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

AddFileToProject(const wsFilename: WideString): WordBool;

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(wbCloseOpenFiles: WordBool): WordBool;

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

OpenProject(const wsProjectFile: WideString): WordBool;

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

RemoveFileFromProject(const wsFilename: WideString): WordBool;

Boolean. Removes the passed file from the active project.

ShowLastProjectError();

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

UploadProjectDlg(): WordBool;

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

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

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

LiveDocs comments are not longer enabled for ColdFusion 5.0. Please use one of the following resources instead.

Version 5.0

Using HomeSite
Scripting the Visual Tools Object Model