PresentationStyleSettings Class

This abstract base class is used to define the settings and common functionality for a specific presentation style.

Definition

Namespace: Sandcastle.Core.PresentationStyle
Assembly: Sandcastle.Core (in Sandcastle.Core.dll) Version: 2024.2.18.0

public abstract class PresentationStyleSettings

Public MustInherit Class PresentationStyleSettings

public ref class PresentationStyleSettings abstract

[<AbstractClassAttribute>]
type PresentationStyleSettings = class end

Presentation styles are singletons by nature. The composition container will create instances as needed.

Constructor

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

CheckForErrors	This is used to check the presentation style for errors
CopyHelpContent	This is used to copy the presentation style help file content to the given destination folder
Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
Finalize	Allows an object to try to free resources and perform other cleanup operations before it is reclaimed by garbage collection. (Inherited from Object)
GetHashCode	Serves as the default hash function. (Inherited from Object)
GetType	Gets the Type of the current instance. (Inherited from Object)
MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object)
ResolvePath	This is used to resolve a presentation style path
ResourceItemFiles	This is used to get an enumerable list of BuildAssembler resource item files used by the presentation style.
ToString	Returns a string that represents the current object. (Inherited from Object)