PresentationStyleSettings Class
Definition
- Namespace
- Sandcastle.Core.PresentationStyle
- Assembly
- Sandcastle.Core.dll
This abstract base class is used to define the settings and common functionality for a specific presentation style.
public abstract class PresentationStyleSettings- Inheritance
-
PresentationStyleSettings
Remarks
Presentation styles are singletons by nature. The composition container will create instances as needed.
Properties
| AdditionalResourceItemsFiles |
This read-only property returns the list of additional resource items files if any |
| ApiTableOfContentsGenerator |
This is used to get or set the table of content generator for API content |
| BasePath |
This is used to get or set the presentation style base path used to resolve relative paths within the presentation style. |
| BuildAssemblerConfiguration |
This is used to get or set the BuildAssembler configuration filename |
| ContentFiles |
This read-only property returns the list of help content file locations |
| DocumentModelApplicator |
This is used to get or set the document model applicator |
| Location |
This is overridden in derived classes to provide the location of the presentation style files |
| PlugInDependencies |
This read-only property returns any plug-in dependencies required by the presentation style |
| RequiresHtmlExtractBuildStep |
This is used to get or set whether or not the presentation style requires the HTML extract build step for website output. |
| SupportedFormats |
This is used to get or set the help file formats supported by the presentation style |
| SupportsCodeSnippetGrouping |
This is used to get or set whether or not code snippet grouping is supported by the presentation style. |
| SupportsNamespaceGrouping |
This is used to get or set whether or not namespace grouping is supported by the presentation style |
| TopicTransformation |
This read-only property returns the topic transformation to use |
Methods
| CheckForErrors() |
This is used to check the presentation style for errors |
| CopyHelpContent(HelpFileFormats, string, Action<string, object[]>, Action<string, string, string>) |
This is used to copy the presentation style help file content to the given destination folder |
| ResolvePath(string) |
This is used to resolve a presentation style path |
| ResourceItemFiles(string) |
This is used to get an enumerable list of BuildAssembler resource item files used by the presentation style. |