Sandcastle Help File Builder Documentation
Sandcastle
This is used to get or set the display version shown below entries in the search results pane in the
help viewer application.
Definition
Namespace: SandcastleBuilder.Utils
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
If not set, a display version will not be shown for topics in the search results pane
Assembly: SandcastleBuilder.Utils (in SandcastleBuilder.Utils.dll) Version: 2024.2.18.0
C#
public string SearchResultsDisplayVersion { get; set; }VB
Public Property SearchResultsDisplayVersion As String
Get
SetC++
public:
property String^ SearchResultsDisplayVersion {
String^ get ();
void set (String^ value);
}F#
member SearchResultsDisplayVersion : string with get, setProperty Value
StringIf not set, a display version will not be shown for topics in the search results pane
Remarks
If set, this typically refers to the SDK name and version or the module in which the member
resides to help differentiate it from other entries with the same title in the search results.