TopicFile Class

TopicFile Class

This class represents a conceptual content topic file

Inheritance Hierarchy

SystemObject
SandcastleBuilder.Utils.ConceptualContentTopicFile

Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2014.11.22.0

Syntax

public class TopicFile

Public Class TopicFile

public ref class TopicFile

type TopicFile =  class end

The TopicFile type exposes the following members.

Constructors

	Name	Description
	TopicFile	Constructor

Methods

	Name	Description
	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 a hash function for a particular type. (Inherited from Object.)
	GetReferencedNamespaces	This is used to get an enumerable list of unique namespaces from the given reflection data file
	GetType	Gets the Type of the current instance. (Inherited from Object.)
	MemberwiseClone	Creates a shallow copy of the current Object. (Inherited from Object.)
	ParseContent	This will parse the file content and extract the document type, unique ID, and revision number.
	ToString	Returns a string that represents the current object. (Inherited from Object.)

Properties

	Name	Description
	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 Invalid.
	FileItem	This is used to get or set the file build item
	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