ContextualHelp
Description:
Contains the details for how Revit should allow invocation of contextual help for an item added by an application.
Contains the details for how Revit should allow invocation of contextual help for an item added by an application.
Remarks:
An instance of this class may be used to assign a contextual help location to any RibbonItem (through the RibbonItem.SetContextualHelp() method). It is also possible to use an instance of this class to launch the help path and topic at any time (this permits association of help topics with user interface components inside dialogs created by the add-in application).
An instance of this class may be used to assign a contextual help location to any RibbonItem (through the RibbonItem.SetContextualHelp() method). It is also possible to use an instance of this class to launch the help path and topic at any time (this permits association of help topics with user interface components inside dialogs created by the add-in application).
Inheritance Hierarchy:
System.Object
Autodesk.Revit.UI.ContextualHelp
System.Object
Autodesk.Revit.UI.ContextualHelp
public class ContextualHelp| Name | Return Type | Description |
|---|---|---|
| ContextualHelp(ContextualHelpType, String) | None | Constructs a contextual help object. |
| Name | Return Type | Description |
|---|---|---|
| Launch() | None | Launches and displays the help topic specified by the contents of this ContextualHelp object. |
| Name | Return Type | Description |
|---|---|---|
| HelpPath | string | The context id, help URL, or help file path. |
| HelpTopicUrl | string | The help topic URL. |
| HelpType | ContextualHelpType | The contextual help type. |