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
128
129
|
<html dir="LTR">
<head>
<meta http-equiv="Content-Type" content="text/html; charset=Windows-1252">
</meta>
<meta name="generator" content="NDoc 1.3" />
<title>Workspace Members</title>
<link rel="stylesheet" type="text/css" href="ndoc.css">
</link>
<script src="ndoc.js" type="text/javascript">
</script>
</head>
<body id="bodyID" class="dtBODY">
<div id="nsbanner">
<div id="bannerrow1">
<table class="bannerparthead" cellspacing="0">
<tr id="hdr">
<td class="runninghead" nowrap="true">NDoc 1.3.1 SDK</td>
<td class="product" nowrap="true">
</td>
</tr>
</table>
</div>
<div id="TitleRow">
<h1 class="dtH1">Workspace Members
</h1>
</div>
</div>
<div id="nstext">
<p>
<a href="NDoc.Core.Workspace.html">Workspace overview</a>
</p>
<h4 class="dtH4">Public Static (Shared) Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><img src="static.gif" /><a href="NDoc.Core.Workspace.GetRelativePath.html">GetRelativePath</a></td><td width="50%"> Return the relative path between two directories </td></tr></table>
</div>
<h4 class="dtH4">Public Instance Constructors</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif" /><a href="NDoc.Core.WorkspaceConstructor.html">Workspace Constructor</a></td><td width="50%"> Creates a new instance of the <a href="NDoc.Core.Workspace.html">Workspace</a> class. </td></tr></table>
</div>
<h4 class="dtH4">Public Instance Properties</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.ContentDirectory.html">ContentDirectory</a></td><td width="50%"> The full path of the help content files </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.ContentDirectoryName.html">ContentDirectoryName</a></td><td width="50%"> The name of the content directory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.ResourceDirectory.html">ResourceDirectory</a></td><td width="50%"> The location where the xslt stylesheets will be unpacked </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.RootDirectory.html">RootDirectory</a></td><td width="50%"> The full path to the worksapce root. This is where project outputs will be saved when compilation is complete </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.WorkingDirectory.html">WorkingDirectory</a></td><td width="50%"> The the full path to the directory where the compilation will run </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubproperty.gif"></img><a href="NDoc.Core.Workspace.WorkingDirectoryName.html">WorkingDirectoryName</a></td><td width="50%"> The name of the directory where the compilation takes place </td></tr></table>
</div>
<h4 class="dtH4">Public Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.AddResourceDirectory.html">AddResourceDirectory</a></td><td width="50%"> Adds a sub directory to the resource directory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.Clean.html">Clean</a></td><td width="50%"> Delets all output and intermediate files from the project workspace This will delete all the cleanable files in the root and remove the working directory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.CleanIntermediates.html">CleanIntermediates</a></td><td width="50%"> Deletes the content of the <a href="NDoc.Core.Workspace.WorkingDirectory.html">WorkingDirectory</a>
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassEqualsTopic.asp">Equals</a> (inherited from <b>Object</b>)</td><td width="50%">
Determines whether the specified <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a> is equal to the current <b>Object</b>.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassGetHashCodeTopic.asp">GetHashCode</a> (inherited from <b>Object</b>)</td><td width="50%">
Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassGetTypeTopic.asp">GetType</a> (inherited from <b>Object</b>)</td><td width="50%">
Gets the <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemTypeClassTopic.asp">Type</a> of the current instance.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.ImportContent_overloads.html">ImportContent</a></td><td width="50%">Overloaded. Copies content into the workspace ContentDirectory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.ImportContentDirectory.html">ImportContentDirectory</a></td><td width="50%"> Recursively copies the contents of sourceDirectory into the workspace content, maintainng the same directory structure </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.ImportProjectFiles_overloads.html">ImportProjectFiles</a></td><td width="50%">Overloaded. Copies project resources into the workspace. Project files are files needed to compile the help file, but are not directly part of its content </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.Prepare.html">Prepare</a></td><td width="50%"> Prepares the workspace, by creating working and content directories </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.RemoveResourceDirectory.html">RemoveResourceDirectory</a></td><td width="50%"> Recursively deletes the ResourceDirectory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="NDoc.Core.Workspace.SaveOutputs.html">SaveOutputs</a></td><td width="50%"> Saves files mathing the specified filter from the build directory to the root directory </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassToStringTopic.asp">ToString</a> (inherited from <b>Object</b>)</td><td width="50%">
Returns a <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemStringClassTopic.asp">String</a> that represents the current <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a>.
</td></tr></table>
</div>
<h4 class="dtH4">Public Instance Events</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="pubevent.gif"></img><a href="NDoc.Core.Workspace.ContentDirectoryAdded.html">ContentDirectoryAdded</a></td><td width="50%"> Event raised when a content directory is added </td></tr>
<tr VALIGN="top"><td width="50%"><img src="pubevent.gif"></img><a href="NDoc.Core.Workspace.ContentFileAdded.html">ContentFileAdded</a></td><td width="50%"> Event raised when a content file is added </td></tr></table>
</div>
<h4 class="dtH4">Protected Instance Methods</h4>
<div class="tablediv">
<table class="dtTABLE" cellspacing="0">
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassFinalizeTopic.asp">Finalize</a> (inherited from <b>Object</b>)</td><td width="50%">
Allows an <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a> to attempt to free resources and perform other cleanup operations before the <b>Object</b> is reclaimed by garbage collection.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassMemberwiseCloneTopic.asp">MemberwiseClone</a> (inherited from <b>Object</b>)</td><td width="50%">
Creates a shallow copy of the current <a href="http://msdn.microsoft.com/library/default.asp?url=/library/en-us/cpref/html/frlrfSystemObjectClassTopic.asp">Object</a>.
</td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.Workspace.OnContentDirectoryAdded.html">OnContentDirectoryAdded</a></td><td width="50%"> Raises the <a href="NDoc.Core.Workspace.ContentDirectoryAdded.html">ContentDirectoryAdded</a> event </td></tr>
<tr VALIGN="top"><td width="50%"><img src="protmethod.gif"></img><a href="NDoc.Core.Workspace.OnContentFileAdded.html">OnContentFileAdded</a></td><td width="50%"> Raises the <a href="NDoc.Core.Workspace.ContentFileAdded.html">ContentFileAdded</a> event </td></tr></table>
</div>
<h4 class="dtH4">See Also</h4>
<p>
<a href="NDoc.Core.Workspace.html">Workspace Class</a> | <a href="NDoc.Core.html">NDoc.Core Namespace</a></p>
<object type="application/x-oleobject" classid="clsid:1e2a7bd0-dab9-11d0-b93a-00c04fc99f9e" viewastext="true" style="display: none;">
<param name="Keyword" value="Workspace class">
</param>
<param name="Keyword" value="NDoc.Core.Workspace class">
</param>
<param name="Keyword" value="Workspace class, all members">
</param>
</object>
<DIV CLASS="footer">
<p>
<center>
<font color="red">
<i>
</i>
</font>
</center>
</p>
</DIV>
<hr />
<div id="footer">
<p>
<a href="mailto:ndoc-helpfeedback@lists.sourceforge.net?subject=NDoc%201.3.1%20SDK%20Documentation%20Feedback:%20Workspace%20Members
 ">Send comments on this topic.</a>
</p>
<p>
NDoc development is hosted by <a href="http://sourceforge.net/" target="_parent"><img alt="SourceForge" src="http://sourceforge.net/sflogo.php?group_id=36057&amp;type=5" align="absMiddle" border="0"></a>
</p>
<p>Generated from assembly NDoc.Core [1.3.1851.0]</p>
</div>
</div>
</body>
</html>
|
