Project Manager

From RAD Studio XE
Jump to: navigation, search

Go Up to View Index

View > Project Manager

Displays and organizes the contents of your current project group and any project it contains. You can perform several project management tasks, such as adding, removing, and compiling files.

Note: Some features described here are available only in specific editions of the product. For example, some functionality in the Project Manager is available only for the C++ personality.

Contents

Nodes and Items on the Project Manager

The contents of the current project is represented by a tree structure in the Project Manager. The various nodes and items in the tree structure are indicated by icons and labels.

Here is a partial list of the icons used in the Project Manager tree structure:

  • ProjGroup.bmp Project group node
  • Project.bmp Project node (typically an .exe file)
    • BuildConfigNode.bmp Build Configurations node
      • BuildConfig.bmp Build configuration (Debug, Release, or custom)
    • Folder.bmp Folder (such as Contains or Requires)
      • UnitFile.bmp Source code (.pas or .cpp) that does not contain a form
      • CodeFile.bmp Source code (.pas or .cpp) that contains a form
      • Resource.bmp Resource file (.res)
      • DFM.bmp Form file (.dfm)
      • Header.bmp Header file (.h) (C++)
      • BPI.bmp Import library for a package (.bpi) (C++)

Project Manager Toolbar

To enable/disable the toolbar on the Project Manager, right-click the Project Manager window and select Toolbar from the context menu.

Item Description

Activate.bmp Activate selected project

Displays the selected project on top of other projects in the IDE so that you can make changes to it. You can also double-click the project to activate it. The active project is displayed in boldface type.

AddNewFile.bmp Add new project

Displays the New Items dialog box so that you can add a new project to the current project group.

RemoveSelected.bmp Remove selected file or project

Removes the selected project from the current project group.

SelectView.bmp Select project view style

Controls the view of the files in your project or project group. Select from three choices:

  • Directory (nested) - each directory is a separate expandable node. This is the default.
  • Directory (flat) - files reside directly under a directory node containing the entire path where they reside.
  • List - no directory nodes are visible.

SyncWEditor.bmp Synchronize selection with editor

Synchronizes the Code Editor with the current selection in the project tree. Expands the tree if necessary and selects from the tree the file that is currently active in the editor (if the file exists in the project tree). The related Auto Track command, on the common context menu, enables and disables continuous synchronization.

ExpandNodes.bmp Expand selected nodes

Opens the currently selected node or nodes in the project tree so that you see the contents of the node or nodes.

CollapseNodes.bmp Collapse selected nodes

Closes the currently selected node or nodes in the project tree so that you see only the node names.

SortBy.jpg Sort Projects By,
Default sort order

Specifies the global sort order to be used in all projects in the current project group (Sort Projects By) or in all subsequently created or imported projects (Default sort order), as follows:

Sort Projects By

Sets the global sort order for all projects in the current project group. Sorts the items listed in the Project Manager according to:

  • Name - alphabetical order using the initial letters in the name of the node or the file (for individual files not inside nodes)
  • Modified date - recently changed files are listed before files with older modification dates
  • Path - alphabetical order using the full path name of the files
  • Type - alphabetical order using the file extension (.pas, .cpp, .res, and so forth)
  • Auto Sort - when checked at the same time as another of the Sort Projects By options, automatically adds new items in the correct order indicated by the checked Sort Projects By selection. Auto Sort is disabled if you rearrange items in the Project Manager using drag-and-drop.

The Build Configurations node remains at the top of the project group and is not sorted. To set the local sort order for a selected project, use the Sort By context menu command. If global sort order is set (using the toolbar), local sort order (using the context menu) is disabled.

Default Sort Order

Sets the global sort order for all projects subsequently opened in the IDE. Sorts the items listed in the Project Manager according to:

  • Name - alphabetical order using the initial letters in the name of the node or the file (for individual files not inside nodes)
  • Modified date - recently changed files are listed before files with older modification dates
  • Path - alphabetical order using the full path name of the files
  • Type - alphabetical order using the file extension (.pas, .cpp, .res, and so forth)
  • Auto Sort - when checked at the same time as another of the Sort Projects By options, automatically adds new items in the correct order indicated by the checked Sort Projects By selection. Auto Sort is disabled if you rearrange items in the Project Manager using drag-and-drop.

The Build Configurations node remains at the top of the project group and is not sorted. To set the local sort order for a selected project, use the Sort By context menu command. If global sort order is set (using the toolbar), local sort order (using the context menu) is disabled.

BuildGroupsIcon.jpg Show Build Groups pane

Displays the Build Groups pane below the Project Manager pane. Use Build Groups to create groups of projects (inside a project group) that you can then build, compile, clean, or delete as a group.

Project list box

Displays the projects in the current project group.

Common Context Menu Commands

The Project Manager has several different context menus, depending on the object you select (project group, project, file, or Build Configurations node). However, most context menus share some of the following common menu commands. The common commands are available when you right-click an empty area on the project list box.

Item Description

Auto Collapse

Collapses the tree structure of the project after you complete an operation.

Auto Track

Turns on/off synchronization between the Code Editor and the Project Manager. When this option is checked, the file currently being edited in the Code Editor is also the focus in the Project Manager. Auto Track enables continuous synchronization, while the related SyncWEditor.bmp Synchronize selection with editor command on the toolbar performs a single synchronization (even when Auto Track is off).

Dockable

When checked, docks (attaches) the Project Manager window to other tool windows, such as the Code Editor. Uncheck this option to make the Program Manager a floating window.

Show Path

Adds an additional field (Path) to the Project Manager to display the path of the files, projects, and project groups.

Status Bar

Displays the full path name of the selected file at the bottom of the Project Manager window. The default is On.

Stay on Top

Displays the Project Manager on top of the desktop even if other windows are displayed.

Toolbar

Shows or hides the toolbar on the top of the Project Manager.

Views

Controls the view of the files in your project or project group. Select from three choices:

  • Directory (nested) - each directory is a separate expandable node. This is the default.
  • Directory (flat) - files reside directly under a directory node that displays the entire path where they reside.
  • List - no directory nodes are visible.

Project Group Context Menu

Right-click a project group to display the following commands.

Item Description

Compile All

Compiles all projects within the current project group that have changed since the last build, and any files that depend on them. (Available only for project groups that contain more than one project.)

Build All

Rebuilds all projects within the current project group regardless of whether they have changed. (Available only for project groups that contain more than one project.)

Clean All

Removes generated files from all projects within the current project group, such as object code files. (Available only for project groups that contain more than one project.)

Add New Project

Displays the New Items dialog box, allowing you to create a new project and add it to the current project group.

Add Existing Project

Displays the Open Project dialog box, allowing you to add an existing project to the current project group.

Save Project Group

Saves the project file (.bdsgroup) for the project group. Use this command after adding, removing, or changing the order of projects in a project group.

Save Project Group As

Displays the Save As dialog box, allowing to save the project with a new name and location.

Rename

Renames the project file.

Subversion

If your project is under version control by Subversion, displays the following commands:

  • Commit launches the Commit (SVN) dialog box and allows you to save the changes to the SVN repository.
    • From Repository Root starts the commit operation at the top level of the repository.
    • From Project Directory starts the commit operation at the project group directory.
    • Files in this Project commits only files in the selected project, including source files and all associated files such as .dfm and .res files. Does not include files that exist only in uses clauses (Delphi) or external headers (C++).
  • Update refreshes the local working copy by pulling the latest version of the file from the SVN repository. Status messages appear in the Messages View. The best practice is to always Update your working copy before you start editing.
    • From Repository Root starts the update operation at the top level of the repository.
    • From Project Directory starts the update operation at the project group directory.
    • Files in this Project updates only files in the selected project, including source files and all associated files such as .dfm and .res files. Does not include files that exist only in uses clauses (Delphi) or external headers (C++).
  • Show Log launches the Log Pane and displays the comments in the Subversion log, as follows:
    • From Repository Root displays the log starting at the top level of the repository.
    • From Project Directory displays the log starting at the project group directory.
  • Clean cleans up interrupted or broken operations and unlocks the selected working copy from the path you select, as follows:
    • From Repository Root starts the clean operation at the top level of the repository.
    • From Project Directory starts the clean operation at the project group directory.

Project Context Menu

Right-click a project file to display the context menu commands.

Item Description

Make (C++) or Compile (Delphi)

Compiles all files in the current project that have changed since it was last built and any files that depend on them.

You can also choose Project > Compile <project name>.

Build

Rebuilds all files in your project regardless of whether they have changed.

You can also choose Project > Build <project name>.

Clean

Removes generated files from the project, such as object code files.

From Here > Make All From Here (C++)

or

From Here > Compile All From Here (Delphi)

Compiles only the selected project and all other projects listed below it in the Project Manger if these projects have changed since the last build. Enabled only when multiple projects are open.

In contrast, choose Project > Compile All Projects (Delphi) or Project > Make All Projects (C++) to rebuild every project that has changed in the project group.

From Here > Build All From Here

Rebuilds only the selected project and all others listed below it in the Project Manager regardless of whether they have changed. Enabled only when multiple projects are open.

In contrast, choose Project > Build All Projects to rebuild all projects in the project group.

From Here > Clean All From Here

Removes generated files (such as object code files) from the project, starting at the selected project and including all other projects listed below it in the Project Manager. Enabled only when multiple projects are open.

Run

Compiles any changed source code and, if the compile is successful, executes your application, allowing you to use and test the application with the debugger built into the IDE.

Also available on the debug toolbar as the Run button and dropdown list of executables (RunButton.jpg, F9).

Run Without Debugging

Compiles any changed source code, and if the compile is successful, executes your application without invoking the debugger built into the IDE.

Also available on the debug toolbar as the RunWithoutDebugging2.jpg button (Shift+Ctrl+F9).

Install | Uninstall

Only for packages (.bpl files). Installs a design-time package and registers the associated component (if a component is present), or uninstalls the design-time package and unregisters the component (if a component is present). See also Install Packages.

Build Sooner

Moves a project up in the list of projects within a project group, which changes the order in which the projects are compiled.

Build Later

Moves a project down in the list of projects within a project group.

TDump

(C++ only) Starts a file dump using TDUMP.exe.

Show in Explorer

Opens the project files in the Windows Explorer. Also available on the file-level context menu.

Add to Version Control

Opens the Import Pane so that you can add files in the project to Subversion. Appears only for projects that are not under version control by Subversion.

Subversion

If your project's project file (.dproj or .cbproj) is under version control by Subversion, the following commands are available:

  • Commit launches the Commit (SVN) dialog box and allows you to save the changes to the SVN repository.
    • From Repository Root starts the commit operation at the top level of the repository.
    • From Project Directory starts the commit operation at the project directory.
    • Files in this Project commits only files in the selected project, including source files and all associated files such as .dfm and .res files. Does not include files that exist only in uses clauses (Delphi) or external headers (C++).
  • Update refreshes the local working copy by pulling the latest version of the file from the SVN repository. Status messages appear in the Messages View. The best practice is to always Update your working copy before you start editing.
    • From Repository Root starts the update operation at the top level of the repository.
    • From Project Directory starts the update operation at the project directory.
    • Files in this Project updates only files in the selected project, including source files and all associated files such as .dfm and .res files. Does not include files that exist only in uses clauses (Delphi) or external headers (C++).
  • Show Log launches the Log Pane and displays the comments in the Subversion log, as follows:
    • From Repository Root displays the log starting at the top level of the repository.
    • From Project Directory displays the log starting at the project directory.
  • Clean cleans up interrupted or broken operations and unlocks the selected working copy from the path you select, as follows:
    • From Repository Root starts the clean operation at the top level of the repository.
    • From Project Directory starts the clean operation at the project directory.
  • Browse Repository opens the Repository Browser and starts at the directory you select, as follows:

Add

Displays the Add to Project dialog box, allowing you to add files to the selected project.

Add New >

Adds a new item to your project, as follows:

  • Unit - Adds a compilation unit to the selected project, assigning the name Unit01.cpp for the first unit added, and then augmenting the number for each subsequent unit added. To rename a unit and all its components, right-click the unit name in the Project Manager, and select Rename.
  • Form - Adds a new form to the selected project and displays the new form in the Code Editor.
  • Other - Displays the New Items dialog box and lists the item categories that are available to you, such as C++Builder Files, or Web Documents. Click a category in the left-hand pane, and then the right-hand pane displays the items of that category that you can add to your project.
  • Folder (C++ only) - Opens the Directory View dialog box, which enables you to browse for a folder and add it to the selected project. You might want to add a folder that you frequently access during program development.
  • Virtual Folder (C++ only) - Adds a grayed-out virtual folder to the selected project. Virtual folders are displayed by default last in the tree structure. Use the context menu for the virtual folder to manage the folder.
  • Customize - Displays the Customize New Menu dialog box and allows you to customize the File > New menu in the product. You can select items, including menu-item separators, from a gallery and add them to your New Items dialog box.

Remove File

Displays the Remove From Project dialog box, allowing you to remove a file from the selected project.

Remove Project

Removes the active project from its project group. Removing the target from the current project group affects the project group's project file (.grouproj); it does not remove any files from disk. Thus, remove a project from your project group before deleting its file from disk so that the product can update the project file accordingly.

Save

Stores changes made to all files in the open project using each file's current name. If you try to save a project that has an unsaved code file, the product opens the Save As dialog box, where you can enter the new filename.

Save As...

Displays the Save As dialog box for each compilation unit that needs to be saved and allows you to enter a new name for each unit.

Rename

Highlights the project node and allows you to enter a new name or edit the existing name of the project.

TDump <filename>

Runs the TDUMP.EXE command line tool on the output of the selected node. For example, on a C++ source file, this command TDumps the .obj, whereas for a project, this command TDumps the .exe/.bpl/.dll. The output from TDump is then opened in the Code Editor for inspection.

Activate

Makes the current project active.

Sort By

Sets the local sort order for the selected project or projects. Sorts the items listed in the Project Manager according to:

  • Name - alphabetical order using the initial letters in the name of the node or the file (for individual files not inside nodes).
  • Modified date - recently changed files are listed before files with older modification dates.
  • Path - alphabetical order using the full path name of the files. Enabled only when the View is set to List. When the View is set to Directory (Nested) or Directory (Flat), the files are implicitly sorted by path because they are displayed in their own directory nodes.
  • Type - alphabetical order using the file extension (.pas, .cpp, .res, and so forth).
  • Build Order - (C++ only) using the build order defined on the Project > Options > Build Order dialog box.
  • Auto Sort - when checked at the same time as another of the Sort By options, automatically adds new items in the correct order indicated by the checked Sort By selection. Auto Sort is disabled if you use drag-and-drop to rearrange items in the Project Manager.

The default order in the Project Manager is alphabetical order. Auto Sort is turned off if you use drag & drop to reorder the files in the project manager, because it is assumed if you rearrange files this way you do not want any sorting done. The sort settings order will be maintained in the project's .local file, and applied whenever the project is reloaded.

The Build Configurations node remains at the top of the project group and is not sorted. To set the global sort order for all projects, click the SortBy.jpg (Sort By) button on the toolbar of the Project Manager. If global sort order is set (using the toolbar), local sort order (using the context menu) is disabled.

View Source

Displays the source code for the selected project.

Dependencies

Displays the Project > Dependencies dialog box, allowing you to change the build order for the projects in a project group. This command is only available if the current project group contains more than one project.

Build Order

(C++ only) Displays the Build Order dialog box, enabling you to move the files that are to be compiled by each compiler (the Resource Compiler, the Turbo Assembler, and the C++ Compiler).

Modeling Support

Displays the Model Support dialog, which lists the projects that are currently open. Select the projects that you want to have modeling support.

Format Project Sources

Formats all source code files in a Delphi or C/C++ project. To set formatting options, use the Tools > Options > Formatter Options page. The formatting options define indentation, spaces, line breaks, capitalization, and align parameters to be used for the code formatting. See Formatting Source Code.

Options

Displays the Project > Options dialog box, allowing you to change the selected project's application and compiler options.

Build Configurations Context Menu

Right-click either the Build Configurations node in the Project Manager or the name of a specific build configuration within the node to display the context menu.

Item Description

Make

Compiles all files in the current project that have changed since it was last built, as well as any files that depend on them. You can also choose Project > Compile [project name] .

Build

Rebuilds all files in your project regardless of whether they have changed. You can also choose Project > [project name] .

Clean

Removes generated files from the project, such as object code files.

Rename

Allows you to rename the selected build configuration.

Delete

Displays the Confirm input box and allows you to delete the selected configuration.

New Configuration

Adds a child configuration, based on the selected configuration, and lists the new configuration in the Project Manager under the name of the parent configuration.

New Option Set

Creates a new option set file (.optset file extension) based on the selected configuration and opens the Save As dialog so that you can specify the name and location for the option set file.

Apply Option Set

Displays the Apply Option Set dialog box and allows you to select an .optset file to apply to the selected build configuration. You can choose to overwrite, replace, or preserve the existing option values.

Activate

Makes the selected build configuration the current active configuration for the project; appears only for configurations that are not currently active. The active build configuration is listed in boldface.

Edit

Displays the Project > Optionsdialog box preloaded with the values set in the selected build configuration.


File Context Menu

Right-click a file within a project to display the context menu commands. The commands vary depending on the type of file selected.

Item Description

Build

Is a shortcut that compiles the selected file.

Compile to Assembly

(C++ only) Compiles the selected source file to an .ASM file and displays the file in the Code Editor.

Edit Local Options

For C++, displays an abbreviated Project Options dialog box that contains only the pages that pertain to the current project and file.

Exclude from build

For C++ only. Temporarily marks the selected file as not part of the build. After you exclude a file from the build, the file name appears grayed out in the Project Manager, and this context menu item has a checkmark. To restore the file to the build, right-click the file in the Project Manager and click the checkmark for this command in the context menu.

Link by Name Only

For C++ only. For a library or object file, locates the file by using the Library Search Path (set on the Project > Options > Directories and Conditionals dialog box).

To link a library or object file explicitly by its file path, uncheck this field, and then the linker receives the fully qualified path name of the library or object file and ignores the Library Search Path setting.

Link by Name Only is the default for .lib and .obj files added to 2009 projects; this option is new for 2009.

Open

Opens the selected files in the Code Editor.

Preprocess

Runs the C++ preprocessor (Cpp32.exe).

Rename

Allows you to rename the file and any corresponding secondary files that appear as child nodes in the Project Manager.

Remove From Project

Removes the selected files from the project. You will be prompted to save any changes.

Save

Saves changes made to the selected files using their current names.

Save As

Displays the Save As dialog box, allowing you to save the selected files with new names and locations.

Show Dependencies

For C++ only. Displays the Project > Dependencies dialog box, allowing you to change the build order for the projects in a project group.

Show in Explorer

Opens the Windows Explorer, displaying the folder that contains the selected file. Also available on the project-level context menu.

Subversion

If files are under version control by Subversion, displays the following commands:

  • Commit opens the Commit (SVN) pane and allows you to save the changes to the SVN repository.
  • Update refreshes the local working copy by pulling the latest version of the file from the SVN repository. Status messages appear in the Messages view. Best practice is to always Update your working copy before you start editing.
  • Browse Repository opens the Repository Browser, displaying the SVN tree structure that contains the file you are editing.

TDump <filename>.obj

For C++ only. Sends the selected file to the TDump utility.

Child Dialog Boxes

See Also

Personal tools
Previous Version
In other languages