Sandcastle Help File Builder Documentation
TopicDisplay
This read-only property is used to get a title for display (i.e. in the designer)
Definition
Namespace: SandcastleBuilder.Utils.ConceptualContent
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
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.
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.12.21.0
C#
public string DisplayTitle { get; }VB
Public ReadOnly Property DisplayTitle As String
GetC++
public:
property String^ DisplayTitle {
String^ get ();
}F#
member DisplayTitle : string with getProperty Value
StringIf 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.