Click or drag to resize
Sandcastle Help File BuilderSandcastleProject Methods

The SandcastleProject type exposes the following members.

Methods
  NameDescription
Public methodAddFileToProject
Add a new file build item to the project
Public methodAddFolderToProject
Add a new folder build item to the project
Public methodStatic memberDefaultBuildAction
This is used to determine the default build action for a file based on its extension.
Public methodDispose
This implements the Dispose() interface to properly dispose of the Sandcastle project object.
Protected methodDispose(Boolean)
This can be overridden by derived classes to add their own disposal code if necessary.
Public methodEnsureProjectIsCurrent
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.
Public methodEquals
Determines whether the specified Object is equal to the current Object.
(Inherited from Object.)
Protected methodFinalize
This handles garbage collection to ensure proper disposal of the Sandcastle project if not done explicitly with Dispose.
(Overrides ObjectFinalize.)
Public methodFindFile
This is used to locate a file by name in the project
Public methodGetHashCode
Serves as a hash function for a particular type.
(Inherited from Object.)
Public methodGetType
Gets the Type of the current instance.
(Inherited from Object.)
Public methodGetUserDefinedProperties
Get a collection containing all user-defined properties
Public methodHasItems
This returns true if the project contains items using the given build action.
Public methodIsValidUserDefinedPropertyName
This is used to determine whether or not the given name can be used for a user-defined project property.
Public methodMarkAsDirty
This is used to mark the project as dirty and in need of being saved.
Protected methodMemberwiseClone
Creates a shallow copy of the current Object.
(Inherited from Object.)
Protected methodOnDirtyChanged
This raises the DirtyChanged event.
Protected methodOnDocumentationSourcesChanged
This raises the DocumentationSourcesChanged event.
Protected methodOnProjectPropertyChanged
This raises the ProjectPropertyChanged event.
Protected methodOnQueryEditProjectFile
This raises the QueryEditProjectFile event.
Public methodRefreshProjectProperties
This refreshes the project instance property values by reloading them from the underlying MSBuild project.
Public methodResolvePath
This method resolves any MSBuild environment variables in the path objects.
Public methodSaveProject
This is used to save the project file
Public methodToString
Returns a string that represents the current object.
(Inherited from Object.)
Public methodUpgradeProjectProperties
This marks the project as dirty along with the project collections for the purpose of upgrading the project.
Top
See Also