TopicFile Class
Definition
- Namespace
- Sandcastle.Core.ConceptualContent
- Assembly
- Sandcastle.Core.dll
This class represents a conceptual content topic file
public class TopicFile- Inheritance
-
TopicFile
Constructors
| TopicFile(ContentFile) |
Constructor |
Properties
| ContentFile |
This is used to get or set the file build item |
| DocumentType |
This read-only property is used to get the document type |
| ErrorMessage |
This read-only property is used to return the error message if DocumentType returns
|
| FullPath |
Get the full path to the file |
| Id |
This is used to get the unique ID of the topic |
| Name |
Get the name of the file without the path |
| RevisionNumber |
This is used to get the topic's revision number |
Methods
| GetReferencedNamespaces(IEnumerable<string>) |
This is used to get an enumerable list of unique namespaces referenced in the topic |
| ParseContent(bool) |
This will parse the file content and extract the document type, unique ID, and revision number |