Module Help_mx.pkg

************************************************************************ Confidential Trade Secret. Copyright (c) 1997 Data Access Corporation, Miami Florida as an unpublished work. All rights reserved. DataFlex is a registered trademark of Data Access Corporation. ************************************************************************/ ************************************************************************ help_mx.pkg Version: 1.0 12-07-1994 : Created Author: John J. Tuohy Use package provides help support to DEO objects. ************************************************************************ 03/29/95 JJT - Converted back to mixin class from include for 3.1 ************************************************************************ 8/29/2002 JJT - Added the various help messages for VDF8.3 This gets these messages out of "for desktop" and into each class. This provides each object with interface support for windows & html help. ************************************************************************

Help_mx.pkg (view source)
• import declarations
  • HelpSystemConstants.pkg (view source)
  • LanguageText.pkg (view source)
• Help_Mixin : Mixin
  • Define_Help_Mixin()
    • IntegerHelp_Id
    • StringHelp_Keyword
    • StringpsHtmlHelpTopic
      added in 11.1 - this will be the recommended method for finding a page (instead of help_id and mapping)
  • DoHtmlHelp()
    • StringsContext
    • IntegereContextFound
  • Extended_Help()
  • Help_For_Help()
  • Help_Index()
  • Keys_Help()
  • File_Help()
  • Error_Help()
  • Help_on_Topic()
  • Help()
    • IntegereHelpType
  • Exec_Help(integer iHelpMessage)
    Protected Message: Send passed message to the help object passing the self
  • stringHelp_Datafile()
    Dummy. Only data-file awre object do this automatically.
  • StringHelp_Context(Integer Context_Type)
    Function Help_Context Integer Context_type returns String This message is sent to an object by the help system. It is up to the object to return a context value. Depending on the type of context requested (context_type) different values are returned. Context_type = HELP_CONTEXT_ID Returns the object's help context Id. Will delegate to the desktop searching for an id. Uses Help_ID property Context_type = HELP_CONTEXT_KEYWORD Returns the object's help keyword Id. Will delegate to the desktop searching for an id. Uses Help_Keyword property Context_type = HELP_CONTEXT_ID_OR_KEY Returns the object's help ID. This can be a context integer ID or a keyword string id. It first looks for the object context_id. If this is non-zero, it returns the id. Otherwise, it checks the object keyword id. If an Id exists it returns it. Else it delegates. Uses properties help_id and help_keyword. Context_type = HELP_CONTEXT_DATAFILE returns the data file and field for the object requesting help. It returns a string in "FILE.FIELD" format. Blank if no File Context_type = HELP_CONTEXT_ERROR Not actually used by DEOs (although it could be). It returns error context (most likely an error number). Is used by the error system.
    • IntegerID
    • StringrVal
  • IntegerHtmlHelpObjectContext(Integer eContext String BYREF sContext)
    return context-type and the context string (by ref) for this one object. The content type to search for is determined by eContext. Usually it will be HELP_CONTEXT_ANY which returns any help context (html page first, id next, keyword last).
    • IntegereContextFound
    • IntegeriId
    • StringsTopic
    • StringsKeyword
  • IntegerHtmlHelpContext(Integer eContext String BYREF sContext)
    Return context-type and the context string (by ref). Delegate until some kind of context is found This message gets augmented at the desktop and at the panel class to stop delegation This is what is no called when you request html help.
    • IntegereContextFound
• DataFile_Help_Mixin : Mixin
  • stringHelp_Datafile()
    • Integerfile#
    • Integerfield#
    • StringrVal

References (1):

Field References (0):