Topic.DisplayTitle Property

TopicDisplayTitle Property

This read-only property is used to get a title for display (i.e. in the designer).

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

Syntax

C++

Copy

public string DisplayTitle { get; }

Public ReadOnly Property DisplayTitle As String
	Get

public:
property String^ DisplayTitle {
	String^ get ();
}

member DisplayTitle : string with get

Property Value

Type: String
If there is a TocTitle specified, it is used. If not, the Title value is used. If it does not contain a value, the filename without the path and extension is used. If the file has not been specified, does not exist, the document type is not recognized, or it is invalid (i.e. badly formed), it returns an appropriate message describing the problem.

Reference

Topic Class

SandcastleBuilder.Utils.ConceptualContent Namespace