Namespaces
- Autodesk.Revit.ApplicationServices
- Autodesk.Revit.Attributes
- Autodesk.Revit.Creation
- Autodesk.Revit.DB
- Autodesk.Revit.DB.Analysis
- Autodesk.Revit.DB.Architecture
- Autodesk.Revit.DB.DirectContext3D
- Autodesk.Revit.DB.Electrical
- Autodesk.Revit.DB.Events
- Autodesk.Revit.DB.ExtensibleStorage
- Autodesk.Revit.DB.ExternalService
- Autodesk.Revit.DB.Fabrication
- Autodesk.Revit.DB.IFC
- Autodesk.Revit.DB.Infrastructure
- Autodesk.Revit.DB.Lighting
- Autodesk.Revit.DB.Macros
- Autodesk.Revit.DB.Mechanical
- Autodesk.Revit.DB.Plumbing
- Autodesk.Revit.DB.PointClouds
- Autodesk.Revit.DB.Steel
- Autodesk.Revit.DB.Structure
- Autodesk.Revit.DB.Structure.StructuralSections
- Autodesk.Revit.DB.Visual
- Autodesk.Revit.Exceptions
- Autodesk.Revit.UI
  - AddInCommandBinding Class
  - ButtonData Class
  - ColorSelectionDialog Class
  - ComboBox Class
  - ComboBoxData Class
  - ComboBoxMember Class
  - ComboBoxMemberData Class
  - CommandMenuItem Class
  - ContextMenu Class
  - ContextualHelp Class
  - ContextualHelpType Enumeration
  - DockablePane Class
  - DockablePaneId Class
  - DockablePaneProviderData Class
  - DockablePanes Class
  - DockablePanes.BuiltInDockablePanes Class
  - DockablePaneState Class
  - DockPosition Enumeration
  - DoubleClickAction Enumeration
  - DoubleClickOptions Class
  - DoubleClickTarget Enumeration
  - EditorInteraction Class
  - EditorInteractionType Enumeration
  - ExternalApplicationArray Class
  - ExternalApplicationArrayIterator Class
  - ExternalCommandData Class
  - ExternalCommandsData Class
  - ExternalEvent Class
  - ExternalEventRequest Enumeration
  - FaceBasedPlacementType Enumeration
  - FamilyInstancePlacingArgs Class
  - FileDialog Class
  - FileOpenDialog Class
  - FileSaveDialog Class
  - FilterDialog Class
  - IContextMenuCreator Interface
  - IControllableDropHandler Interface
  - IDockablePaneProvider Interface
  - IDropHandler Interface
  - IExternalApplication Interface
  - IExternalCommand Interface
  - IExternalCommandAvailability Interface
  - IExternalEventHandler Interface
  - IExternalResourceUIServer Interface
  - IFCExternalServiceUIData Class
  - IFrameworkElementCreator Interface
  - IIFCEntityTreeUIServer Interface
  - IRevisionsOnSheetUIServer Interface
  - ItemData Class
  - ITemporaryGraphicsHandler Interface
  - ItemSelectionDialogResult Enumeration
  - MenuItem Class
  - PostableCommand Enumeration
  - PreviewControl Class
  - ProjectBrowserOptions Class
  - PromptForFamilyInstancePlacementOptions Class
  - PulldownButton Class
  - PulldownButtonData Class
  - PushButton Class
  - PushButtonData Class
  - RadioButtonGroup Class
  - RadioButtonGroupData Class
  - Result Enumeration
  - RevisionsOnSheetUIServiceData Class
  - RevitCommandId Class
  - RevitLinkUIUtils Class
  - RibbonButton Class
  - RibbonButtonOptions Class
  - RibbonItem Class
  - RibbonItemData Class
  - RibbonItemType Enumeration
  - RibbonPanel Class
  - ScrollbarVisibility Enumeration
  - SelectionUIOptions Class
  - SeparatorItem Class
  - SketchGalleryOptions Enumeration
  - SplitButton Class
  - SplitButtonData Class
  - SubMenuItem Class
  - Tab Enumeration
  - TabbedDialogAction Delegate
  - TabbedDialogExtension Class
  - TableViewUIUtils Class
  - TaskDialog Class
  - TaskDialogCommandLinkId Enumeration
  - TaskDialogCommonButtons Enumeration
  - TaskDialogIcon Enumeration
  - TaskDialogResult Enumeration
  - TemporaryGraphicsCommandData Class
  - TextBox Class
  - TextBoxData Class
  - TextEditorOptions Class
  - ThemeType Enumeration
  - ThinLinesOptions Class
  - ToggleButton Class
  - ToggleButtonData Class
  - UIApplication Class
  - UIControlledApplication Class
  - UIDocument Class
  - UIFabricationUtils Class
  - UISaveAsOptions Class
  - UITheme Enumeration
  - UIThemeManager Class
  - UIView Class
- Autodesk.Revit.UI.Events
- Autodesk.Revit.UI.Macros
- Autodesk.Revit.UI.Mechanical
- Autodesk.Revit.UI.Plumbing
- Autodesk.Revit.UI.Selection
WhatsNew
Revit .NET 8 Upgrade Tips

ContextualHelp Class

Revit 2025.3 API

ContextualHelp Class

Contains the details for how Revit should allow invocation of contextual help for an item added by an application.

Inheritance Hierarchy

SystemObject
Autodesk.Revit.UIContextualHelp

Namespace: Autodesk.Revit.UI
Assembly: RevitAPIUI (in RevitAPIUI.dll) Version: 25.3.0.0 (25.3.0.0)

Syntax

public class ContextualHelp

Public Class ContextualHelp

public ref class ContextualHelp

type ContextualHelp = class end

The ContextualHelp type exposes the following members.

Constructors

	Name	Description
	ContextualHelp	Constructs a contextual help object.

Properties

	Name	Description
	HelpPath	The context id, help URL, or help file path.
	HelpTopicUrl	The help topic URL.
	HelpType	The contextual help type.

Methods

	Name	Description
	Equals	Determines whether the specified object is equal to the current object. (Inherited from Object)
	GetHashCode	Serves as the default hash function. (Inherited from Object)
	GetType	Gets the Type of the current instance. (Inherited from Object)
	Launch	Launches and displays the help topic specified by the contents of this ContextualHelp object.
	ToString	Returns a string that represents the current object. (Inherited from Object)

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).

See Also

Reference

Autodesk.Revit.UI Namespace

Send comments on this topic to Autodesk

T:Autodesk.Revit.UI.ContextualHelp