home *** CD-ROM | disk | FTP | other *** search
/ Visual Basic Controls / Visual Basic Controls.iso / vbcontrol / axtree / contxtid.bas < prev    next >
Encoding:
BASIC Source File  |  1999-02-03  |  10.1 KB  |  234 lines
  1. Attribute VB_Name = "ContextIDs"
  2. Option Explicit
  3. '=====================================================================
  4. '=====================================================================
  5. '
  6. 'This source code contains the following routines:
  7. '  o SetAppHelp() 'Called in the main Form_Load event to register your
  8. '                 'program with WINHELP.EXE
  9. '  o QuitHelp()    'Deregisters your program with WINHELP.EXE. Should
  10. '                  'be called in your main Form_Unload event
  11. '  o ShowHelpTopic(Topicnum) 'Brings up context sensitive help based on
  12. '                  'any of the following CONTEXT IDs
  13. '  o ShowContents  'Displays the startup topic
  14. '  o HelpWindowSize(x,y,dx,dy) ' Position help window in a screen
  15. '                              ' independent manner
  16. '  o SearchHelp()  'Brings up the windows help KEYWORD SEARCH dialog box
  17. '***********************************************************************
  18. '
  19. '=====================================================================
  20. 'List of Context IDs for <axTree>
  21. '=====================================================================
  22. Global Const Hlp_Contents = 10    'Main Help Window
  23. Global Const Hlp_Revisions = 30    'Main Help Window
  24. Global Const Hlp_License = 40    'Main Help Window
  25. Global Const Hlp_Tech_Support = 50    'Main Help Window
  26. Global Const Hlp_Properties = 60    'Second Help Window
  27. Global Const Hlp_Methods = 70    'Second Help Window
  28. Global Const Hlp_Events = 80    'Second Help Window
  29. Global Const Hlp_Standard = 90    'Main Help Window
  30. Global Const Hlp_Collapse = 110    'Second Help Window
  31. Global Const Hlp_Expand = 120    'Second Help Window
  32. Global Const Hlp_AddNode = 130    'Second Help Window
  33. Global Const Hlp_Clear = 140    'Second Help Window
  34. Global Const Hlp_Collapse1 = 150    'Second Help Window
  35. Global Const Hlp_CollapseAll = 160    'Second Help Window
  36. Global Const Hlp_Expand1 = 170    'Second Help Window
  37. Global Const Hlp_ExpandAll = 180    'Second Help Window
  38. Global Const Hlp_Find = 190    'Second Help Window
  39. Global Const Hlp_Item = 200    'Second Help Window
  40. Global Const Hlp_ItemData = 210    'Second Help Window
  41. Global Const Hlp_RemoveNode = 220    'Second Help Window
  42. Global Const Hlp_AutoCheckParents = 230    'Second Help Window
  43. Global Const Hlp_BorderStyle = 240    'Second Help Window
  44. Global Const Hlp_BorderStyleInner = 250    'Second Help Window
  45. Global Const Hlp_Checkmarks = 260    'Second Help Window
  46. Global Const Hlp_Count = 270    'Second Help Window
  47. Global Const Hlp_PictureClosed = 280    'Second Help Window
  48. Global Const Hlp_PictureClosedSome = 290    'Second Help Window
  49. Global Const Hlp_PictureClosedAll = 300    'Second Help Window
  50. Global Const Hlp_PictureItemNotSelected = 310    'Second Help Window
  51. Global Const Hlp_PictureItemSelected = 320    'Second Help Window
  52. Global Const Hlp_PictureOpen = 330    'Second Help Window
  53. Global Const Hlp_PictureOpenSome = 340    'Second Help Window
  54. Global Const Hlp_PictureOpenAll = 350    'Second Help Window
  55. Global Const Hlp_SelectColor = 360    'Second Help Window
  56. Global Const Hlp_SelectTextColor = 370    'Second Help Window
  57. Global Const Hlp_SelectedItem = 390    'Second Help Window
  58. Global Const Hlp_ShowBitmaps = 400    'Second Help Window
  59. Global Const Hlp_ShowPlusSigns = 410    'Second Help Window
  60. Global Const Hlp_ShowLines = 420    'Second Help Window
  61. Global Const Hlp_NodeClick = 430    'Main Help Window
  62. Global Const Hlp_ParentIndex = 440    'Second Help Window
  63. '=====================================================================
  64. '
  65. '
  66. '  Help engine section.
  67.  
  68. Automatic generation of constants disabled by user!
  69. Dim MainWindowInfo as HELPWININFO
  70. Public Sub SetAppHelp (ByVal hWndMainWindow)
  71. '=====================================================================
  72. 'To use these subroutines to access WINHELP, you need to add
  73. 'at least this one subroutine call to your code
  74. '     o  In the Form_Load event of your main Form enter:
  75. '        Call SetAppHelp(Me.hWnd) 'To setup helpfile variables
  76. '         (If you are not interested in keyword searching or context
  77. '         sensitive help, this is the only call you need to make!)
  78. '=====================================================================
  79.     m_hWndMainWindow = hWndMainWindow
  80.     If Right$(Trim$(App.Path),1) = "\" then
  81.         App.HelpFile = App.Path + "axTree.HLP"
  82.     else
  83.         App.HelpFile = App.Path + "\axTree.HLP"
  84.     end if
  85.     MainWindowInfo.wStructSize = 26
  86.     MainWindowInfo.X=256
  87.     MainWindowInfo.Y=256
  88.     MainWindowInfo.dX=512
  89.     MainWindowInfo.dY=512
  90.     MainWindowInfo.rgChMember=Chr$(0)+Chr$(0)
  91. End Sub
  92. Public Sub QuitHelp ()
  93.     Dim Result as Variant
  94.     Result = WinHelp(m_hWndMainWindow, App.HelpFile, HELP_QUIT, Chr$(0) + Chr$(0) + Chr$(0) + Chr$(0))
  95. End Sub
  96. Public Sub ShowHelpTopic (ByVal ContextID As Long)
  97. '=====================================================================
  98. '  FOR CONTEXT SENSITIVE HELP IN RESPONSE TO A COMMAND BUTTON ...
  99. '=====================================================================
  100. '     o   For 'Help button' controls, you can call:
  101. '         Call ShowHelpTopic(<any Hlpxxx entry above>)
  102. '=====================================================================
  103. '  TO ADD FORM LEVEL CONTEXT SENSITIVE HELP...
  104. '=====================================================================
  105. '     o  For FORM level context sensetive help, you should set each 
  106. '        Me.HelpContext=<any Hlp_xxx entry above>
  107. '
  108.     Dim Result as Variant
  109.  
  110.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_CONTEXT, Clng(ContextID))
  111.  
  112. End Sub
  113. Public Sub ShowHelpTopic2 (ByVal ContextID As Long)
  114. '=====================================================================
  115. '  DISPLAY CONTEXT SENSITIVE HELP IN WINDOW 2 ...
  116. '=====================================================================
  117. '     o   For 'Help button' controls, you can call:
  118. '         Call ShowHelpTopic2(<any Hlpxxx entry above>)
  119. '
  120.     Dim Result as Variant
  121.  
  122.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile &">HlpWnd02", HELP_CONTEXT, Clng(ContextID))
  123.  
  124. End Sub
  125. Public Sub ShowHelpTopic3 (ByVal ContextID As Long)
  126. '=====================================================================
  127. '  DISPLAY CONTEXT SENSITIVE HELP IN WINDOW 3 ...
  128. '=====================================================================
  129. '     o   For 'Help button' controls, you can call:
  130. '         Call ShowHelpTopic3(<any Hlpxxx entry above>)
  131. '
  132.     Dim Result as Variant
  133.  
  134.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile &">HlpWnd03", HELP_CONTEXT, Clng(ContextID))
  135.  
  136. End Sub
  137. Public Sub ShowGlossary ()
  138.     Dim Result as Variant
  139.  
  140.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_CONTEXT, Clng(64000))
  141.  
  142. End Sub
  143. Public Sub ShowPopupHelp (ByVal ContextID As Long)
  144. '=====================================================================
  145. '  FOR POPUP HELP IN RESPONSE TO A COMMAND BUTTON ...
  146. '=====================================================================
  147.     Dim Result as Variant
  148.  
  149.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_CONTEXTPOPUP, Clng(ContextID))
  150.  
  151. End Sub
  152. Public Sub DoHelpMacro (ByVal MacroString As String)
  153. '=====================================================================
  154. '  FOR POPUP HELP IN RESPONSE TO A COMMAND BUTTON ...
  155. '=====================================================================
  156.     Dim Result as Variant
  157.  
  158.     Result = WinHelpByStr(m_hWndMainWindow, APP.HelpFile, HELP_COMMAND, ByVal(Macrostring))
  159.  
  160. End Sub
  161. Public Sub ShowHelpContents ()
  162. '=====================================================================
  163. '  DISPLAY STARTUP TOPIC IN RESPONSE TO A COMMAND BUTTON or MENU ...
  164. '=====================================================================
  165. '
  166.     Dim Result as Variant
  167.  
  168.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_CONTENTS, Clng(0))
  169.  
  170. End Sub
  171. Public Sub ShowContentsTab ()
  172. '=====================================================================
  173. '  DISPLAY Contents tab (*.CNT)
  174. '=====================================================================
  175. '
  176.     Dim Result as Variant
  177.  
  178.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_FINDER, Clng(0))
  179.  
  180. End Sub
  181. Public Sub ShowHelpOnHelp ()
  182. '=====================================================================
  183. '  DISPLAY HELP for WINHELP.EXE  ...
  184. '=====================================================================
  185. '
  186.     Dim Result as Variant
  187.  
  188.     Result = WinHelpByNum(m_hWndMainWindow, APP.HelpFile, HELP_HELPONHELP, Clng(0))
  189.  
  190. End Sub
  191.  
  192. Public Sub SearchHelp ()
  193. '=====================================================================
  194. '  TO ADD KEYWORD SEARCH CAPABILITY...
  195. '=====================================================================
  196. '     o   In your Help|Search menu selection, simply enter:
  197. '         Call SearchHelp() 'To invoke helpfile keyword search dialog
  198. '
  199.     Dim Result as Variant
  200.  
  201.     Result = WinHelp(m_hWndMainWindow, APP.HelpFile, HELP_PARTIALKEY, ByVal "" )
  202.  
  203. End Sub
  204.  
  205. Public Sub SearchHelpKeyWord (Argument as String)
  206. '=====================================================================
  207. '  TO ADD KEYWORD SEARCH CAPABILITY...
  208. '=====================================================================
  209. '     o   In your Help|Search menu selection, simply enter:
  210. '         Call SearchHelp() 'To invoke helpfile keyword search dialog
  211. '
  212.     Dim Result as Variant
  213.  
  214.     Result = WinHelp(m_hWndMainWindow, APP.HelpFile, HELP_PARTIALKEY, ByVal Trim$(Argument))
  215.  
  216. End Sub
  217. Public Sub HelpWindowSize (x As Integer, y As Integer, wx As Integer, wy As Integer)
  218. '=====================================================================
  219. '  TO SET THE SIZE AND POSITION OF THE MAIN HELP WINDOW...
  220. '=====================================================================
  221. '     o   Call HelpWindowSize(x, y, dx, dy), where:
  222. '             x = 1-1024 (position from left edge of screen)
  223. '             y = 1-1024 (position from top of screen)
  224. '             dx= 1-1024 (width)
  225. '             dy= 1-1024 (height)
  226. '
  227.     Dim Result as Variant
  228.     MainWindowInfo.x = x
  229.     MainWindowInfo.y = y
  230.     MainWindowInfo.dx = wx
  231.     MainWindowInfo.dy = wy
  232.     Result = WinHelpByInfo(m_hWndMainWindow, App.HelpFile, HELP_SETWINPOS, MainWindowInfo)
  233. End Sub
  234.