Sandcastle Help File Builder Documentation
SandcastleProject Methods
Methods
| AddFileToProject | Add a new file build item to the project |
| AddFolderToProject | Add a new folder build item to the project |
| ContentFiles | This returns an enumerable list of content files of the given type contained in the project or some other source. |
| DefaultBuildAction | This is used to determine the default build action for a file based on its extension |
| Dispose | This properly disposes of the Sandcastle project |
| Equals | Determines whether the specified object is equal to the current object. (Inherited from Object) |
| Finalize |
This handles garbage collection to ensure proper disposal of the Sandcastle project if not done
explicitly with Dispose().
(Overrides Object.Finalize()) |
| FindFile | This is used to locate a file by name in the project |
| GetHashCode | Serves as the default hash function. (Inherited from Object) |
| GetType | Gets the Type of the current instance. (Inherited from Object) |
| HasItems | This returns true if the project contains items using the given build action |
| IsValidUserDefinedPropertyName | This is used to determine whether or not the given name can be used for a user-defined project property. |
| RefreshProjectProperties | This refreshes the project instance property values by reloading them from the underlying MSBuild project. |
| ReplacementValueFor | This is used by the replacement tag handler to get simple project property values that require no other modification or simple ones that can be handled here. |
| ResolvePath | This method resolves any MSBuild environment variables in the path objects |
| SaveProject | This is used to save the project file |
| ToString | Returns a string that represents the current object. (Inherited from Object) |