SandcastleProject Properties |
The SandcastleProject type exposes the following members.
Name | Description | |
---|---|---|
ApiFilter |
This is used to get the API filter collection.
| |
AutoDocumentConstructors |
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.
| |
AutoDocumentDisposeMethods |
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.
| |
BasePath |
This read-only property returns the base path
| |
BinaryTOC |
This is used to get or set the path to the Sandcastle components
| |
BuildAssemblerVerbosity |
This is used to get or set the build assembler tool verbosity level
| |
BuildLogFile |
This is used to get or set the path and filename of the build log file
| |
CatalogName |
This is used to get or set the MS Help Viewer 2.x content catalog name.
| |
CatalogProductId |
This is used to get or set the Product ID portion of the MS Help Viewer 1.0 Catalog ID.
| |
CatalogVersion |
This is used to get or set the Version portion of the MS Help Viewer 1.0 Catalog ID.
| |
CleanIntermediates |
This is used to get or set whether intermediate files are deleted after a successful build
| |
CollectionTocStyle |
This is used to get or set the collection table of contents style
used when plugged into an MS Help 2 collection.
| |
ComponentConfigurations |
This is used to get a dictionary of build component configurations.
| |
ComponentPath |
This is used to get or set the path to a folder containing additional, project-specific build
components.
| |
Configuration |
This is used to get or set the configuration to use when building
the project.
| |
ContentPlacement |
This is used to get or set the placement of any additional and
conceptual content items in the table of contents.
| |
CopyrightHref |
This is used to get or set the URL to use as the link for the
copyright notice.
| |
CopyrightText |
This is used to get or set the copyright notice that appears in
the footer of each page.
| |
CppCommentsFixup |
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.
| |
DecodedCopyrightText |
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.
| |
DisableCodeBlockComponent |
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.
| |
DocumentationSources |
Returns the list of documentation sources to use in building the
help file.
| |
DocumentAttributes |
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.
| |
DocumentExplicitInterfaceImplementations |
This is used to get or set whether or not explicit interface implementations are documented
| |
DocumentInheritedFrameworkInternalMembers |
This is used to get or set whether or not inherited internal framework members are documented
| |
DocumentInheritedFrameworkMembers |
This is used to get or set whether or not inherited framework members are documented
| |
DocumentInheritedFrameworkPrivateMembers |
This is used to get or set whether or not inherited private framework members are documented
| |
DocumentInheritedMembers |
This is used to get or set whether or not inherited members are documented
| |
DocumentInternals |
This is used to get or set whether or not internal members are documented in the help file
| |
DocumentNoPIATypes |
This is used to get or set whether or not no-PIA (Primary Interop Assembly) embedded interop types
are documented in the help file.
| |
DocumentPrivateFields |
This is used to get or set whether or not private fields are documented in the help file
| |
DocumentPrivates |
This is used to get or set whether or not private members are documented in the help file
| |
DocumentProtected |
This is used to get or set whether or not protected members are documented in the help file
| |
DocumentProtectedInternalAsProtected |
This is used to get or set whether or not "protected internal" members are documented as "protected"
only in the help file.
| |
DocumentSealedProtected |
This is used to get or set whether or not protected members of sealed classes are documented in the
help file.
| |
FeedbackEMailAddress |
This is used to get or set the feedback e-mail address that
appears in the footer of each page.
| |
FeedbackEMailLinkText |
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.
| |
FileItems |
This returns a collection of all build items in the project that
represent folders and files.
| |
Filename |
This read-only property is used to get the filename for the project
| |
FooterText |
This is used to get or set additional text that should appear
in the footer of every page.
| |
FrameworkVersion |
This is used to get or set the .NET Framework version used to resolve references to system types
(basic .NET Framework, Silverlight, Portable, etc.).
| |
HeaderText |
This is used to get or set additional text that should appear
in the header of every page.
| |
HelpAttributes |
This is used to get a collection of additional Help 2 attributes
that will be added to each generated help topic.
| |
HelpFileFormat |
This is used to get or set the help file format generated by the build process
| |
HelpFileVersion |
This is used to get or set the version number applied to the
help file.
| |
HelpTitle |
This is used to get or set the help file's title
| |
HtmlHelp1xCompilerPath |
This is used to get or set the path to the HTML Help 1 compiler
(HHC.EXE).
| |
HtmlHelp2xCompilerPath |
This is used to get or set the path to the MS Help 2 compiler
(HXCOMP.EXE).
| |
HtmlHelpName |
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).
| |
HtmlSdkLinkType |
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.
| |
IncludeFavorites |
This is used to get or set whether or not a Favorites tab will
appear in the help file.
| |
IncludeStopWordList |
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.
| |
IndentHtml |
This is used to get or set whether or not the HTML rendered by BuildAssembler is indented.
| |
IsDirty |
This is used to get the dirty state of the project
| |
KeepLogFile |
This is used to get or set whether or not the log file is retained after a successful build
| |
Language |
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.
| |
LogFileLocation |
This read-only property is used to get the build log file
location.
| |
MaximumGroupParts |
This is used to get or set the maximum number of namespace parts to consider when namespace grouping
is enabled.
| |
MissingTags |
This read-only helper property returns the flags to use when
looking for missing tags.
| |
MSBuildOutDir |
This is used to get or set the MSBuild OutDir property value
that is defined when using Team Build.
| |
MSBuildProject |
This read-only property is used to get the underlying MSBuild
project.
| |
MSHelp2SdkLinkType |
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.
| |
MSHelpViewerSdkLinkType |
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.
| |
NamespaceGrouping |
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.
| |
NamespaceSummaries |
Returns the list of namespace summaries
| |
NamingMethod |
This is used to get or set the naming method used to generate the help topic filenames
| |
OutputPath |
This is used to get or set the path to which the help files
will be generated.
| |
Platform |
This is used to get or set the platform to use when building the
project.
| |
PlugInConfigurations |
This is used to get a dictionary of build process plug-in configurations
| |
PlugInNamespaces |
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.
| |
Preliminary |
This is used to get or set whether or not all pages should be
marked with a "preliminary documentation" warning in the page
header.
| |
PresentationStyle |
This is used to get or set the presentation style for the help topic pages.
| |
ProductTitle |
This is used to get or set the product title for the help viewer file
| |
ProjectSummary |
This is used to get or set the project summary comments
| |
References |
This is used to get a collection of reference dependencies (files,
GAC, COM, or project) for MRefBuilder if needed.
| |
RootNamespaceContainer |
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.
| |
RootNamespaceTitle |
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.
| |
SdkLinkTarget |
This is used to get or set the target window for MSDN SDK links.
| |
ShowMissingIncludeTargets |
This is used to get or set whether or not missing <include>
tag target documentation is indicated in the help file.
| |
ShowMissingNamespaces |
This is used to get or set whether or not missing namespace
comments are indicated in the help file.
| |
ShowMissingParams |
This is used to get or set whether or not missing <param>
tags are indicated in the help file.
| |
ShowMissingRemarks |
This is used to get or set whether or not missing <remarks>
tags are indicated in the help file.
| |
ShowMissingReturns |
This is used to get or set whether or not missing <returns>
tags are indicated in the help file.
| |
ShowMissingSummaries |
This is used to get or set whether or not missing <summary>
tags are indicated in the help file.
| |
ShowMissingTypeParams |
This is used to get or set whether or not missing <typeparam>
tags on generic types and methods are indicated in the help file.
| |
ShowMissingValues |
This is used to get or set whether or not missing <value>
tags are indicated in the help file.
| |
SyntaxFilters |
This is used to get or set the language filters which determines which languages appear in the
Syntax section of the help topics.
| |
TocOrder |
This is used to get or set the sort order for conceptual content so that it appears within its
parent in the correct position.
| |
TocParentId |
This is used to get or set the table of contents parent for each root
topic in the help file.
| |
TocParentVersion |
This is used to get or set the topic version of the TocParentId topic
| |
TopicVersion |
This is used to get or set the topic version for each topic in the help file
| |
TransformComponentArguments |
This returns an enumerable list of transform component arguments
| |
UsingFinalValues |
This read-only property is used to get whether or not the project
is using final values for the project properties.
| |
VendorName |
This is used to get or set the vendor name for the help viewer file
| |
VisibleItems |
This read-only helper property returns the flags used to indicate
which optional items to document.
| |
WebsiteSdkLinkType |
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.
| |
WorkingPath |
This is used to get or set the path to the working folder used
during the build process to store the intermediate files.
|