NDoc 1.3.1 SDK

Workspace Methods

The methods of the Workspace class are listed below. For a complete list of Workspace class members, see the Workspace Members topic.

Public Static (Shared) Methods

GetRelativePath Return the relative path between two directories

Public Instance Methods

AddResourceDirectory Adds a sub directory to the resource directory
Clean 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
CleanIntermediates Deletes the content of the WorkingDirectory
Equals (inherited from Object) Determines whether the specified Object is equal to the current Object.
GetHashCode (inherited from Object) Serves as a hash function for a particular type, suitable for use in hashing algorithms and data structures like a hash table.
GetType (inherited from Object) Gets the Type of the current instance.
ImportContentOverloaded. Copies content into the workspace ContentDirectory
ImportContentDirectory Recursively copies the contents of sourceDirectory into the workspace content, maintainng the same directory structure
ImportProjectFilesOverloaded. Copies project resources into the workspace. Project files are files needed to compile the help file, but are not directly part of its content
Prepare Prepares the workspace, by creating working and content directories
RemoveResourceDirectory Recursively deletes the ResourceDirectory
SaveOutputs Saves files mathing the specified filter from the build directory to the root directory
ToString (inherited from Object) Returns a String that represents the current Object.

Protected Instance Methods

Finalize (inherited from Object) Allows an Object to attempt to free resources and perform other cleanup operations before the Object is reclaimed by garbage collection.
MemberwiseClone (inherited from Object) Creates a shallow copy of the current Object.
OnContentDirectoryAdded Raises the ContentDirectoryAdded event
OnContentFileAdded Raises the ContentFileAdded event

See Also

Workspace Class | NDoc.Core Namespace