Opening a custom chm file from Ribbon button in Revit

By Partha Sarkar

We can use ContextualHelp class to associate custom help. ContextualHelp allows us to start a locally installed help (chm) file, or linking to an external URL for custom help. The ContextualHelp class is used to create a type of contextual help, and then RibbonItem.SetContextualHelp() or RibbonItemData.SetContextualHelp() is used to associate it with a control. When a ContextualHelp instance is associated with a control, the text "Press F1 for more help" will appear below the tooltip when the mouse hovers over the control as shown below –

And here is the relevant C# .NET code snippet :

PushButtonData pushButtonDataHello 
  = newPushButtonData(
    "PushButtonHello", 
    "Hello World", 
    _introLabPath,
    _introLabName + ".HelloWorld" ); 
 
PushButton pushButtonHello = panel.AddItem(pushButtonDataHello) asPushButton;
pushButtonHello.LargeImage = NewBitmapImage("ImgHelloWorld.png");     
pushButtonHello.ToolTip = "simple push button";
 
// ContextualHelp class is used to create a type of contextual help      
 
ContextualHelp contextHelp = new ContextualHelp(ContextualHelpType.ChmFile, @"C:TempToolTipDemo.chm");
pushButtonHello.SetContextualHelp(contextHelp);

Hope this is useful to you!