Click or drag to resize
Sandcastle Help File BuilderSandcastleBuilder.Utils Namespace
This namespace contains various utility classes and the help file builder project classes.
Classes
  ClassDescription
Public classApiFilter
This represents an API entry that is to be removed from the reflection information using MRefBuilder's namespace ripping feature.
Public classApiFilterCollection
This collection class is used to hold the API filter entries for MRefBuilder to remove
Public classBaseBuildItem
This is a base wrapper class for a build item in the project
Public classBuilderException
This exception class is thrown by the application if it encounters an unrecoverable error.
Public classCOMReferenceItem
This represents a COM reference item that can be used by MRefBuilder to locate assembly dependencies for the assemblies being documented.
Public classDocumentationSource
This represents an assembly, an XML comments file, a Visual Studio Solution (C#, VB.NET, or J#), or a Visual Studio solution containing one or more C#, VB.NET or J# projects to use for building a help file.
Public classDocumentationSourceCollection
This collection class is used to hold the documentation sources
Public classFileItem
This class represents a file that is part of the project (MAML/additional content, site map, stylesheet, etc.).
Public classFileItemCollection
This collection class is used to hold build items from a project.
Public classFilePath
This class is used to represent a file path. Support is included for treating the path as fixed or relative and for expanding environment variables in the path name.
Public classFolderPath
This class is used to represent a folder path. Support is included for treating the path as fixed or relative and for expanding environment variables in the path name.
Public classMSHelpAttr
This represents an MS Help 2 attribute that can be added to the XML data island in each help topic generated by BuildAssembler.
Public classMSHelpAttrCollection
This collection class is used to hold the help attribute items for a project
Public classMSHelpKeyword
This represents an MS Help 2 index keyword that can be added to the XML data island in each help topic generated by BuildAssembler.
Public classMSHelpKeywordCollection
This collection class is used to hold the help index keyword items for a project.
Public classNamespaceSummaryItem
This represents a a namespace summary item that can be used to add comments to a namespace in the help file or exclude it completely from the help file.
Public classNamespaceSummaryItemCollection
This collection class is used to hold the namespace summary items for a project
Public classProjectElement
This class is a wrapper for build items in the project.
Public classProjectFileConfiguration
This holds configuration settings for Visual Studio project file documentation sources
Public classProjectPropertyChangedEventArgs
This event arguments class is used to specify which project property changed along with the old and new values.
Public classProjectReferenceItem
This represents a project reference item that can be used by MRefBuilder to locate assembly dependencies for the assemblies being documented.
Public classPropertyBasedCollectionItem
This is the base class for collection items that are stored in an MSBuild property element.
Public classReferenceItem
This represents a reference item that can be used by MRefBuilder to locate assembly dependencies for the assemblies being documented.
Public classReferenceItemCollection
This collection class is used to hold the reference items for a project
Public classSandcastleProject
This class represents all of the properties that make up a Sandcastle Help File Builder project
Public classUtility
This class contains utility and extension methods
Interfaces
  InterfaceDescription
Public interfaceIBasePathProvider
This interface defines the properties used to obtain a base path for a FilePath object.
Enumerations
  EnumerationDescription
Public enumerationApiEntryType
This public enumerated type defines the API entry types that can be removed from the reflection information file.
Public enumerationBuildAction
This defines the build action (item name) for build items in a project
Public enumerationBuildAssemblerVerbosity
This public enumerated type defines the build assembler tool verbosity levels
Public enumerationCollectionTocStyle
This public enumerated type defines the collection table of contents style for MS Help 2 collections.
Public enumerationContentPlacement
This public enumerated type defines the placement of the additional content items in the table of contents if any are defined.
Public enumerationDocumentType
This public enumerated type defines the conceptual document types
Public enumerationHtmlSdkLinkType
This public enumerated type defines the type of links used to reference other help topics referring to framework (SDK) help topics in HTML Help 1 and website help files.
Public enumerationMissingTags
This public enumerated type defines the missing documentation tags for which to search.
Public enumerationMSHelp2SdkLinkType
This public enumerated type defines the type of links used to reference other help topics referring to framework (SDK) help topics in MS Help 2 help files.
Public enumerationMSHelpViewerSdkLinkType
This public enumerated type defines the type of links used to reference other help topics referring to framework (SDK) help topics in MS Help Viewer help files.
Public enumerationNamingMethod
This public enumerated type defines the naming method to use for the help topic filenames
Public enumerationSdkLinkTarget
This public enumerated type defines the locations in which a browser window can be opened for the MSDN SDK links.
Public enumerationVisibleItems
This public enumerated type defines the optional visible items in the help file