Class wwhelpform

This class is internally created by Help Builder and is accessible through the COM interface through the wwHelp.OpenForm() and thereafter with the wwHelp.oForm reference.

This class inherits from Visual FoxPro's base form class so the public base form interface is available in addition to the application specific interface described here. For more info on the base interface please see:

Form Object Properties, Methods and Events

Parent Class: Fsorm

Class Members

MemberDescription

activatebodyfield

Sets focus to the Body field if the form is in text editing mode. Used frequently when new topics are created or focus is changed from view to edit mode.

o.activatebodyfield()

addviewer

Creates the Document view of the Help Builder form.

o.addviewer(lnMode)

buildtree

Updates the TreeView of Topics.

o.buildtree(lcPK)

closeproject

Closes the currently active project.

o.closeproject()

deletetopic

Deletes the currently selected topic.

o.deletetopic()

gethwnd

Returns Help Builder's main Hwnd Window Handle.

o.gethwnd()

gotopic

Goes to the specified topic and updates the display. This method calls back into wwHelp::LoadTopic and then displays the topic and updates the UI if found.

o.gotopic(lcValue, lnTopicType, llNoSave,lcAnchor)

open

Opens a Help Builder Project. If the filename is passed as a blank string an interactive find file dialog displays to select a project file.

o.open(lcFileName, llForce, llSilent)

preview

This method is responsible for actually rendering the HTML and displaying output for the HTML viewer documents.

o.preview(llViewer,lcAnchor)

printtopics

Prints a topic branch topics starting with a certain topic.

o.printtopics(lcPK, llReturnAsString)

runwizard

Runs one of Help Builder's built-in Wizards.

o.runwizard(lcWizClass, lcParm2)

savetopic

Saves the currently active topic in Help Builder and writes it to disk. This happens automatically for the most part, but this allows programmatic control over the unbinding process.

o.savetopic(llCompareBeforeSave)

statusmessage

This method is used to display informational messages in Help Builder. Output can go to the Status bar or one of the progress or informational dialogs.

o.statusmessage(lcMessage, lcPanel, lnPercent, lcHeader)

updatetreenode

Updates the text of the specified topic in the tree if the value is visible.

o.updatetreenode(pcKey, pcText)

lnoopenfile

Determines whether there is an open project file or not.

lnotopic

True when no topic is active

nstatustype

The type of status display is used.

nviewmode

Determines the current view mode of the Document viewer.

oconfig

Configuration object that hold Help Builder's and the project's configuration settings. These settings map to the settings stored in wwhelp.ini as well as to the project settings found in the CONFIG record of the project.


© West Wind Techologies, 2018 • Updated: 08/13/15
Comment or report problem with topic