Autodesk.Revit.UI.ContextualHelp

Autodesk.Revit.UI.ContextualHelp是一个与Revit用户界面交互的API类，用于在程序界面中提供上下文帮助信息。

方法

该类包含以下方法：

ShowHelp

public static void ShowHelp(UIControlledApplication application, ContextualHelp contextualHelp)

该方法用于显示上下文帮助信息。需要传入UIControlledApplication类型的应用程序对象和ContextualHelp类型的上下文帮助对象。调用该方法后，会在程序界面中显示帮助信息。

属性

该类包含以下属性：

HelpTopicUrl

public string HelpTopicUrl { get; }

该属性用于获取帮助主题的URL地址。此属性初始化时需要使用ContextualHelp类的构造函数，以传入URL地址。

HelpTooltip

public string HelpTooltip { get; }

该属性用于获取帮助提示文本。此属性初始化时需要使用ContextualHelp类的构造函数，以传入提示文本。

用法示例

以下代码段展示了如何使用ContextualHelp类：

ContextualHelp contextualHelp = new ContextualHelp(
    ContextualHelpType.Url,
    "https://www.autodesk.com/products/revit/overview"
);

Autodesk.Revit.UI.ContextualHelp.ShowHelp(
    application,
    contextualHelp
);

在程序界面中显示URL地址对应的帮助信息。

注意事项

• 必须在UI线程中调用ShowHelp方法。
• 在初始化ContextualHelp实例时，需要指定一个有效的URL地址或提示文本。