ProjectManager Object

The ProjectManager object provides extensive and granular scripting capabilities.

This section groups the PropertyManager methods by function.

FileCount

Syntax

FileCount: Integer (read-only) 

Description

The number of files in the project.

IsDirty

Syntax

IsDirty: WordBool (read-only) 

Description

Boolean. Differences exist between the project as viewed in the Visual Tools and the underlying disk structure.

IsFileSelected

Syntax

IsFileSelected: WordBool (read-only) 

Description

Boolean. Selects the file in the project.

Path

Syntax

Path: OleVariant (read-only) 

Description

Default project path.

SelectedFile

Syntax

SelectedFile: OleVariant (read-write) 

Description

Gets and sets variant property.

Methods

AddFile

Syntax

AddFile(Filename: OleVariant); 

Description

Adds a file to the project.

AddFolder

Syntax

AddFolder(Folder: OleVariant; FolderType: TFolderType; FolderPath: Ole-Variant; Parent: OleVariant); 

Description

Adds a new folder to the project root. To add a subfolder to an existing folder, use a folder-level method.

CheckedIn

Syntax

CheckedIn: WordBool; 

Description

Boolean. Checks a project into source control.

CreateProject

Syntax

CreateProject(ProjectName: OleVariant; ProjectPath: OleVariant); 

Description

Creates a new project.

DeployScriptList

Syntax

DeployScriptList: OleVariant; 

Description

List scripts associated witht the project.

DeployServerList

Syntax

DeployServerList: OleVariant; 

Description

Lists servers associated with the project.

FolderList

Syntax

FolderList: OleVariant; 

Description

Lists project subfolders.

Open

Syntax

Open(ProjectName: OleVariant); 

Description

Opens a new project.

RemoveFile

Syntax

RemoveFile(Filename: OleVariant); 

Description

Removes a file from the project.

RemoveFolder

Syntax

RemoveFolder(FolderName: OleVariant); 

Description

Removes a folder from the project.

Save

Syntax

Save; 

Description

Saves the current project to disk in WDDX format.

SelectFile

Syntax

SelectFile(Filename: OleVariant); 

Description

Selects a file for source control operations.

Folder methods

FolderAddFile

Syntax

FolderAddFile(Folder: OleVariant; Filename: OleVariant); 

Description

Add a file to the specified folder.

FolderAllFiles

Syntax

FolderAllFiles(Folder: OleVariant): OleVariant; 

Description

Lists all files within the specified project.

FolderChangeType

Syntax

FolderChangeType(Folder: OleVariant; FolderType: TFolderType); 

Description

Changes the folder type.

FolderContainsFile

Syntax

FolderContainsFile(Folder: OleVariant; Filename: OleVariant): WordBool; 

Description

Boolean. Determines if a file is contained within a project folder.

FolderDeployTarget

Syntax

FolderDeployTarget(Folder: OleVariant; out FolderType: Integer; out FolderTarget: OleVariant); 

Description

Gets the folder deployment target and type.

FolderFileCount

Syntax

FolderFileCount(Folder: OleVariant): Integer; 

Description

Counts the number of files in the project folder.

FolderRemoveFile

Syntax

FolderRemoveFile(Folder: OleVariant; Filename: OleVariant); 

Description

Removes file from specified folder.

FolderRenameFile

Syntax

FolderRenameFile(Folder: OleVariant; OldName: OleVariant; NewName: Ole-Variant); 

Description

Renames a file within a project.

FolderSubFolderExists

Syntax

FolderSubFolderExists(Folder: OleVariant; SubFolderName: OleVariant): WordBool; 

Description

Boolean. Determines if a subfolder exists.

FolderSubFolders

Syntax

FolderSubFolders(Folder: OleVariant): OleVariant; 

Description

Lists all subfolders within the project folder.

FolderType

Syntax

FolderType(Folder: OleVariant): Integer; 

Description

Returns the specified folder type.

Deployment methods

DeploymentScriptAdd

Syntax

DeploymentScriptName: OleVariant; 

Description

Adds a deployment script to the project.

DeploymentScriptCount

Syntax

DeploymentScriptCount: Integer; 

Description

Returns the number of scripts.

DeploymentScriptList

Syntax

DeploymentScriptList: OleVariant; 

Description

Lists all project deployment scripts.

DeploymentScriptRemove

Syntax

DeploymentScriptRemove(ScriptName: OleVariant); 

Description

Removes a deployment script from the project.

DeploymentServerAdd

Syntax

DeploymentServerAdd(ServerName: OleVariant; ServerNum: Integer); 

Description

Adds a deployment server to the project.

DeploymentServerCount

Syntax

DeploymentServerCount: Integer; 

Description

Returns the number of deployment servers.

DeploymentServerList

Syntax

DeploymentServerList: OleVariant; 

Description

Lists deployment servers.

DeploymentServerRemove

Syntax

DeploymentServerRemove(ServerName: OleVariant); 

Description

Removes a deployment server from a project.

Comments