![]() | SandcastleProject Methods |
The SandcastleProject type exposes the following members.
Name | Description | |
---|---|---|
![]() | AddFileToProject |
Add a new file build item to the project
|
![]() | AddFolderToProject |
Add a new folder build item to the project
|
![]() ![]() | DefaultBuildAction |
This is used to determine the default build action for a file based
on its extension.
|
![]() | Dispose |
This implements the Dispose() interface to properly dispose of the Sandcastle project object.
|
![]() | Dispose(Boolean) |
This can be overridden by derived classes to add their own disposal code if necessary.
|
![]() | EnsureProjectIsCurrent |
This is used to ensure that all local collection project properties
have been stored in the MSBuild project file and that path-type
properties are current based on the current project location.
|
![]() | Equals | (Inherited from Object.) |
![]() | Finalize |
This handles garbage collection to ensure proper disposal of the Sandcastle project if not done
explicitly with Dispose.
(Overrides ObjectFinalize.) |
![]() | FindFile |
This is used to locate a file by name in the project
|
![]() | GetHashCode | Serves as a hash function for a particular type. (Inherited from Object.) |
![]() | GetType | Gets the Type of the current instance. (Inherited from Object.) |
![]() | GetUserDefinedProperties |
Get a collection containing all user-defined properties
|
![]() | 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.
|
![]() | MarkAsDirty |
This is used to mark the project as dirty and in need of being
saved.
|
![]() | MemberwiseClone | Creates a shallow copy of the current Object. (Inherited from Object.) |
![]() | OnDirtyChanged |
This raises the DirtyChanged event.
|
![]() | OnDocumentationSourcesChanged |
This raises the DocumentationSourcesChanged event.
|
![]() | OnProjectPropertyChanged |
This raises the ProjectPropertyChanged event.
|
![]() | OnQueryEditProjectFile |
This raises the QueryEditProjectFile event.
|
![]() | RefreshProjectProperties |
This refreshes the project instance property values by reloading them
from the underlying MSBuild project.
|
![]() | 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.) |
![]() | UpgradeProjectProperties |
This marks the project as dirty along with the project collections
for the purpose of upgrading the project.
|