Table of Contents

Topic.DisplayTitle Property

Definition

Namespace
Sandcastle.Core.ConceptualContent
Assembly
Sandcastle.Core.dll

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

public string DisplayTitle { get; }

Property Value

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.