Click or drag to resize
Sandcastle Help File BuilderSandcastleProject Properties

The SandcastleProject type exposes the following members.

Properties
  NameDescription
Public propertyApiFilter
This is used to get the API filter collection.
Public propertyAutoDocumentConstructors
This is used to get or set whether or not constructors are automatically documented if they are missing the <summary> tag and for classes with compiler generated constructors.
Public propertyAutoDocumentDisposeMethods
This is used to get or set whether or not dispose methods are automatically documented if they are missing the <summary> tag and for classes with compiler generated dispose methods.
Public propertyBasePath
This read-only property returns the base path
Public propertyBinaryTOC
This is used to get or set the path to the Sandcastle components
Public propertyBuildAssemblerVerbosity
This is used to get or set the build assembler tool verbosity level
Public propertyBuildLogFile
This is used to get or set the path and filename of the build log file
Public propertyCatalogName
This is used to get or set the MS Help Viewer 2.x content catalog name.
Public propertyCatalogProductId
This is used to get or set the Product ID portion of the MS Help Viewer 1.0 Catalog ID.
Public propertyCatalogVersion
This is used to get or set the Version portion of the MS Help Viewer 1.0 Catalog ID.
Public propertyCleanIntermediates
This is used to get or set whether intermediate files are deleted after a successful build
Public propertyCollectionTocStyle
This is used to get or set the collection table of contents style used when plugged into an MS Help 2 collection.
Public propertyComponentConfigurations
This is used to get a dictionary of build component configurations.
Public propertyComponentPath
This is used to get or set the path to a folder containing additional, project-specific build components.
Public propertyConfiguration
This is used to get or set the configuration to use when building the project.
Public propertyContentPlacement
This is used to get or set the placement of any additional and conceptual content items in the table of contents.
Public propertyCopyrightHref
This is used to get or set the URL to use as the link for the copyright notice.
Public propertyCopyrightText
This is used to get or set the copyright notice that appears in the footer of each page.
Public propertyCppCommentsFixup
This is used to get or set whether to fix-up the XML comments files to work around an issue with those generated by the C++ compiler.
Public propertyDecodedCopyrightText
This is used to get the copyright notice that appears in the footer of each page with any hex value place holders replaced with their actual character.
Public propertyDisableCodeBlockComponent
This is used to disable the custom Code Block Component so that <code> elements are rendered in their standard format by the Sandcastle XSL transformations.
Public propertyDocumentationSources
Returns the list of documentation sources to use in building the help file.
Public propertyDocumentAttributes
This is used to get or set whether or not attributes on types and members are documented in the syntax portion of the help file.
Public propertyDocumentExplicitInterfaceImplementations
This is used to get or set whether or not explicit interface implementations are documented
Public propertyDocumentInheritedFrameworkInternalMembers
This is used to get or set whether or not inherited internal framework members are documented
Public propertyDocumentInheritedFrameworkMembers
This is used to get or set whether or not inherited framework members are documented
Public propertyDocumentInheritedFrameworkPrivateMembers
This is used to get or set whether or not inherited private framework members are documented
Public propertyDocumentInheritedMembers
This is used to get or set whether or not inherited members are documented
Public propertyDocumentInternals
This is used to get or set whether or not internal members are documented in the help file
Public propertyDocumentNoPIATypes
This is used to get or set whether or not no-PIA (Primary Interop Assembly) embedded interop types are documented in the help file.
Public propertyDocumentPrivateFields
This is used to get or set whether or not private fields are documented in the help file
Public propertyDocumentPrivates
This is used to get or set whether or not private members are documented in the help file
Public propertyDocumentProtected
This is used to get or set whether or not protected members are documented in the help file
Public propertyDocumentProtectedInternalAsProtected
This is used to get or set whether or not "protected internal" members are documented as "protected" only in the help file.
Public propertyDocumentSealedProtected
This is used to get or set whether or not protected members of sealed classes are documented in the help file.
Public propertyFeedbackEMailAddress
This is used to get or set the feedback e-mail address that appears in the footer of each page.
Public propertyFeedbackEMailLinkText
This is used to get or set the feedback e-mail link text that appears in the feedback e-mail link in the footer of each page.
Public propertyFileItems
This returns a collection of all build items in the project that represent folders and files.
Public propertyFilename
This read-only property is used to get the filename for the project
Public propertyFooterText
This is used to get or set additional text that should appear in the footer of every page.
Public propertyFrameworkVersion
This is used to get or set the .NET Framework version used to resolve references to system types (basic .NET Framework, Silverlight, Portable, etc.).
Public propertyHeaderText
This is used to get or set additional text that should appear in the header of every page.
Public propertyHelpAttributes
This is used to get a collection of additional Help 2 attributes that will be added to each generated help topic.
Public propertyHelpFileFormat
This is used to get or set the help file format generated by the build process
Public propertyHelpFileVersion
This is used to get or set the version number applied to the help file.
Public propertyHelpTitle
This is used to get or set the help file's title
Public propertyHtmlHelp1xCompilerPath
This is used to get or set the path to the HTML Help 1 compiler (HHC.EXE).
Public propertyHtmlHelp2xCompilerPath
This is used to get or set the path to the MS Help 2 compiler (HXCOMP.EXE).
Public propertyHtmlHelpName
This is used to get or set the name of the compiled help file. Do not include a path or the extension. For MS Help 2 builds, this is also used as the collection namespace name (avoid spaces).
Public propertyHtmlSdkLinkType
This is used to get or set the type of links used to reference other help topics referring to framework (SDK) help topics in HTML Help 1 help files.
Public propertyIncludeFavorites
This is used to get or set whether or not a Favorites tab will appear in the help file.
Public propertyIncludeStopWordList
This is used to get or set whether or not to include the stop word list used to identify words to omit from the Help 2 full text search index.
Public propertyIndentHtml
This is used to get or set whether or not the HTML rendered by BuildAssembler is indented.
Public propertyIsDirty
This is used to get the dirty state of the project
Public propertyKeepLogFile
This is used to get or set whether or not the log file is retained after a successful build
Public propertyLanguage
This is used to get or set the language option for the help file and to determine which set of presentation resource files to use.
Public propertyLogFileLocation
This read-only property is used to get the build log file location.
Public propertyMaximumGroupParts
This is used to get or set the maximum number of namespace parts to consider when namespace grouping is enabled.
Public propertyMissingTags
This read-only helper property returns the flags to use when looking for missing tags.
Public propertyMSBuildOutDir
This is used to get or set the MSBuild OutDir property value that is defined when using Team Build.
Public propertyMSBuildProject
This read-only property is used to get the underlying MSBuild project.
Public propertyMSHelp2SdkLinkType
This is used to get or set the type of links used to reference other help topics referring to framework (SDK) help topics in MS Help 2 help files.
Public propertyMSHelpViewerSdkLinkType
This is used to get or set the type of links used to reference other help topics referring to framework (SDK) help topics in MS Help Viewer help files.
Public propertyNamespaceGrouping
This is used to get or set whether namespace grouping is enabled. The presentation style must have support for namespace grouping in order for the feature to work.
Public propertyNamespaceSummaries
Returns the list of namespace summaries
Public propertyNamingMethod
This is used to get or set the naming method used to generate the help topic filenames
Public propertyOutputPath
This is used to get or set the path to which the help files will be generated.
Public propertyPlatform
This is used to get or set the platform to use when building the project.
Public propertyPlugInConfigurations
This is used to get a dictionary of build process plug-in configurations
Public propertyPlugInNamespaces
This is used to get or set a comma-separated list of namespaces that the collection will be plugged into when deployed using H2Reg.exe.
Public propertyPreliminary
This is used to get or set whether or not all pages should be marked with a "preliminary documentation" warning in the page header.
Public propertyPresentationStyle
This is used to get or set the presentation style for the help topic pages.
Public propertyProductTitle
This is used to get or set the product title for the help viewer file
Public propertyProjectSummary
This is used to get or set the project summary comments
Public propertyReferences
This is used to get a collection of reference dependencies (files, GAC, COM, or project) for MRefBuilder if needed.
Public propertyRootNamespaceContainer
This is used to get or set whether or not a root namespace entry is added to the table of contents to act as a container for the namespaces from the documented assemblies.
Public propertyRootNamespaceTitle
This is used to get or set an alternate title for the root namespaces page and the root table of contents container that appears when RootNamespaceContainer is set to true.
Public propertySdkLinkTarget
This is used to get or set the target window for MSDN SDK links.
Public propertyShowMissingIncludeTargets
This is used to get or set whether or not missing <include> tag target documentation is indicated in the help file.
Public propertyShowMissingNamespaces
This is used to get or set whether or not missing namespace comments are indicated in the help file.
Public propertyShowMissingParams
This is used to get or set whether or not missing <param> tags are indicated in the help file.
Public propertyShowMissingRemarks
This is used to get or set whether or not missing <remarks> tags are indicated in the help file.
Public propertyShowMissingReturns
This is used to get or set whether or not missing <returns> tags are indicated in the help file.
Public propertyShowMissingSummaries
This is used to get or set whether or not missing <summary> tags are indicated in the help file.
Public propertyShowMissingTypeParams
This is used to get or set whether or not missing <typeparam> tags on generic types and methods are indicated in the help file.
Public propertyShowMissingValues
This is used to get or set whether or not missing <value> tags are indicated in the help file.
Public propertySyntaxFilters
This is used to get or set the language filters which determines which languages appear in the Syntax section of the help topics.
Public propertyTocOrder
This is used to get or set the sort order for conceptual content so that it appears within its parent in the correct position.
Public propertyTocParentId
This is used to get or set the table of contents parent for each root topic in the help file.
Public propertyTocParentVersion
This is used to get or set the topic version of the TocParentId topic
Public propertyTopicVersion
This is used to get or set the topic version for each topic in the help file
Public propertyTransformComponentArguments
This returns an enumerable list of transform component arguments
Public propertyUsingFinalValues
This read-only property is used to get whether or not the project is using final values for the project properties.
Public propertyVendorName
This is used to get or set the vendor name for the help viewer file
Public propertyVisibleItems
This read-only helper property returns the flags used to indicate which optional items to document.
Public propertyWebsiteSdkLinkType
This is used to get or set the type of links used to reference other help topics referring to framework (SDK) help topics in HTML Help 1 help files.
Public propertyWorkingPath
This is used to get or set the path to the working folder used during the build process to store the intermediate files.
Top
See Also