Bring up Help Builder from the current Source Code Member

Help Builder can also automatically pop up your help topic context sensitively from C# or VB.NET source code. If the member was previously imported either via the Class Import Wizard or through the IDE integration features to Update or add Help Builder Topic from Source Code Blocks Help Builder finds the topic and displays it for editing.

To do this simply right click in the Source Code C# or VB.NET editor and place the cursor over a class, method, property, field or event and right click, then select Show Help Builder. You can also press Alt-F1 if menu integration has been hooked up.

Work Hint:
Once Help Builder pops up use the Topmost button on the toolbar to set Help Builder to stay always on top so you can work with VS.NET and Help Builder at the same time. Keep the Help Builder window relatively small and let it float over the IDE. This is very useful if you're documenting forms or code you are currently working on. When checked Help Builder stays on top and you can either minimize the form or click on the topmost button again.

If the topic was previously created Help Builder navigates to this topic and displays this topic ready for editing or display depending on your current view. If the topic does not exist Help Builder pops up a dialog that asks if you want to add a new topic to match.

If you select Yes the steps of this process are identical to the Update or add Help Builder Topic from Source Code Block, which imports all information about about the member including XML Comments if available in the source code.


  Last Updated: 9/3/2004 | © West Wind Techologies, 2007