WWHAPI_Object
Constructor:
WWHAPI_Object(ParamHelpURL, ParamTargetWindow)Methods:
WWHAPI_CloseHelp()WWHAPI_DisplayHelp(ParamContext, ParamTopic)WWHAPI_DisplayHelpWithNavigation(ParamContext, ParamTopic)WWHAPI_DisplayHelpWithContents(ParamContext, ParamTopic)WWHAPI_DisplayHelpWithIndex(ParamContext, ParamTopic)WWHAPI_DisplayHelpWithSearch(ParamContext, ParamTopic)WWHAPI_DisplayHelpWithFavorites(ParamContext, ParamTopic)WWHAPI_DisplayHelpNavigation()
Constructor:
WWHAPI_Object(ParamHelpURL, ParamTargetWindow);Parameters:
ParamHelpURL (string): Complete URL to directory that contains "wwhelp" subdirectory.ParamTargetWindow (string): Name of browser window to create for this instance of WWHAPI_Object.Description:
Creates an instance of the WWHAPI_Object that corresponds to a browser window instance.
Example:
var MyHelpset; MyHelpset = new WWHAPI_Object("http://www.webworks.com/docs/helpset1", "help_window");
Method:
WWHAPI_CloseHelp();Parameters: None
Description:
Closes browser window for this instance of the WWHAPI_Object.
Example:
MyHelpset.WWHAPI_CloseHelp();
Method:
WWHAPI_DisplayHelp(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads without any navigation components, the correct helpset volume (context) and topic as specified by the parameters, without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelp("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpWithNavigation(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads with most recently called tab opened ("contents" if not previously called), the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpWithNavigation("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpWithContents(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads with "contents" tab opened, the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpWithContents("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpWithIndex(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads with "index" tab opened, the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpWithIndex("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpWithSearch(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads with "search" tab opened, the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpWithSearch("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpWithFavorites(ParamContext, ParamTopic);Parameters:
ParamContext (string): WebWorks Help assigned "context" name of volume (helpset top-level grouping).ParamTopic (string): Assigned "TopicAlias" name for specific location in given helpset (same as TopicAlias marker value).Description:
Loads with "favorites" tab opened, the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpWithFavorites("volume1", "myTopicAliasValue");
Method:
WWHAPI_DisplayHelpNavigation();Parameters: None
Description:
Loads splash page or first topic along with navigation components, the correct helpset volume (context) and topic as specified by the parameters without re-loading the browser window, except if this is the first call.
Example:
MyHelpset.WWHAPI_DisplayHelpNavigation();