summaryrefslogtreecommitdiffstats
path: root/tools/NUnit/doc/projectEditor.html
blob: 6b56a448e1ee6862a5ab563cdf77b511f1fb0668 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.0//EN">
<html>
<!-- Standard Head Part -->
<head>
<title>NUnit - ProjectEditor</title>
<meta http-equiv="Content-Type" content="text/html; charset=windows-1252">
<meta http-equiv="Content-Language" content="en-US">
<link rel="stylesheet" type="text/css" href="nunit.css">
<link rel="shortcut icon" href="favicon.ico">
</head>
<!-- End Standard Head Part -->

<body>

<!-- Standard Header for NUnit.org -->
<div id="header">
  <a id="logo" href="http://www.nunit.org"><img src="img/logo.gif" alt="NUnit.org" title="NUnit.org"></a>
  <div id="nav">
    <a href="http://www.nunit.org">NUnit</a>
    <a class="active" href="index.html">Documentation</a>
  </div>
</div>
<!-- End of Header -->

<div id="content">

<h2>Project Editor</h2>

<p>The Project Editor is displayed through the Project | Edit menu item and allows creating or
modifying NUnit test projects. It should be noted that a Test Project is active whenever any tests
have been loaded, even if no project was explicitly created or referenced. In the case of an
assembly being loaded, an internal wrapper project is created. This allows the user to change
settings and save the project directly without needing to perform any extra steps. The editor
consists of a common area and two tabs, as seen in the image below.</p>

<h3>Common Area</h3>

<p>The common area of the Project Editor contains a label showing the full path 
   to the project file. There is an edit box, allowing the user to change
   the project AppBase, which defaults to the directory of the project file.
   There is also a dropdown combo box permitting selection of the configuration 
   to be edited and a button, which opens the 
   <a href="configEditor.html">Configuration Editor</a>.</p>

<div class="screenshot-left">
<img src="img/generalTab.jpg"></div>

<h3>General Tab</h3>

<p>The General tab allows setting a number of options pertaining to the selected configuration, all of
which will be stored in the NUnit project file as attributes of the <config> xml node.</p>

<h4>ApplicationBase</h4>
<p>The ApplicationBase defaults to the directory containing the project file. Beginning
with NUnit 2.2.3, it may be set to any location that is desired.</p>

<h4>Configuration File Name</h4>
<p>The configuration file defaults to the name of the test project with the extension changed
from .nunit to .config. The user may substitute another name.</p>

<h4>PrivateBinPath</h4>
<p>By default, the PrivateBinPath is generated from the assembly locations specified on the
Assemblies Tab. For those applications requiring a different level of control, it may be
specified manually or using this editor or placed in the configuration file.</p>

<h3>Assemblies Tab</h3>

<p>The assemblies tab contains the list of assemblies that form part of this test project.</p>

<p>Note: Although the dialog shows the location of assemblies as absolute paths, they are always
persisted in the NUnit project file as paths relative to the application base. This allows moving
projects as a whole to a different directory location.</p>

<div class="screenshot-left">
<img src="img/assembliesTab.jpg"></div>

<h4>Add...</h4>
<p>Opens a dialog allowing adding an assembly to this configuration. If Visual
Stuio support is enabled, you may also select and add a VS project.</p>

<h4>Remove</h4>
<p>After confirmation, removes the selected assembly from this configuration.</p>

<h4>Assembly Path</h4>
<p>This text box displays the full path to the selected assembly. You may edit
the contents to change the path to the assembly.

</div>

<!-- Submenu -->
<div id="subnav">
<ul>
<li><a href="index.html">NUnit 2.4.7</a></li>
<ul>
<li><a href="getStarted.html">Getting&nbsp;Started</a></li>
<li><a href="assertions.html">Assertions</a></li>
<li><a href="attributes.html">Attributes</a></li>
<li><a href="nunit-console.html">Console&nbsp;Runner</a></li>
<li><a href="nunit-gui.html">Gui&nbsp;Runner</a></li>
<ul>
<li><a href="guiCommandLine.html">Command-Line</a></li>
<li><a href="mainMenu.html">Main&nbsp;Menu</a></li>
<li><a href="contextMenu.html">Context&nbsp;Menu</a></li>
<li><a href="optionsDialog.html">Options&nbsp;Dialog</a></li>
<li><a href="addinsDialog.html">Addins&nbsp;Dialog</a></li>
<li><a href="testProperties.html">Test&nbsp;Properties</a></li>
<li><a href="configEditor.html">Configuration&nbsp;Editor</a></li>
<li id="current"><a href="projectEditor.html">Project&nbsp;Editor</a></li>
</ul>
<li><a href="features.html">Other&nbsp;Features</a></li>
<li><a href="releaseNotes.html">Release&nbsp;Notes</a></li>
<li><a href="samples.html">Samples</a></li>
<li><a href="license.html">License</a></li>
</ul>
</ul>
</div>
<!-- End of Submenu -->


<!-- Standard Footer for NUnit.org -->
<div id="footer">
  Copyright &copy; 2008 Charlie Poole. All Rights Reserved.
</div>
<!-- End of Footer -->

</body>
</html>