API Reference

Detailed and full API reference helps you master Tekla development

This is the most recent version of Tekla Open API.
For older versions, please visit Tekla Warehouse.

Meta.Microsoft.Help.Id
M:Tekla.Structures.Dialog.HelpViewer.DisplayHelpTopic(System.String)

HelpViewerDisplayHelpTopic Method

Method for opening Tekla Structures help viewer with given help topic. Method requires Tekla Structures to be running.

Namespace:  Tekla.Structures.Dialog
Assembly:  Tekla.Structures.Dialog (in Tekla.Structures.Dialog.dll) Version: 2020.0.0.0 (2020.0.55582.0)
Syntax
public static bool DisplayHelpTopic(
	string helpTopic
)

Parameters

helpTopic
Type: SystemString
Help topic (e.g. Help file name without extension).

Return Value

Type: Boolean
True if success, otherwise false.
Exceptions
Exception Condition
InvalidOperationException Thrown when connection to Tekla Structures failed.
See Also