Class wwHelpForm

An implementation of the Help Builder IDE. This is the form based interface that you see when help builder runs. This class wrappers the Help Builder COM object (wwHelp.wwHelpForm) and makes passthrough calls via Reflection.

System.Object
  Westwind.wwHelp.wwHelpComWrapper
    Westwind.wwHelp.wwHelpForm
public class wwHelpForm : wwHelpComWrapper

Class Members

MemberDescription

Constructor

Overridden Constructor that must be passed a COM reference to the wwHelpForm Com object. All properties then map via Reflection.

Activate

Activates the Help Builder Window and makes it the Active application window.

public void Activate();

ActivateBodyField

Activates the Body field on the form for the current topic. Does not work if in HTML mode - call AddViewer(1) to force into HTML view first.

public void ActivateBodyField();

AddViewer

Switches View modes for the Help Builder Form.

public void AddViewer( ViewerModes ViewerMode );

CloseProject

Closes the currently open IDE Project

public void CloseProject();

CreateInstance

Static Factory method that creates an instance of this class. Instantiates the COM object and creates the wrapper for you.

public static wwHelpForm CreateInstance();

DeleteTopic

Deletes the currently active IDE topic. Prompts with dialog.

public void DeleteTopic();

GoTopic

Goes to the specified topic and displays it in the viewer in the current display mode.

public void GoTopic( string Pk,
    TopicTypes TopicType,
    bool NoSave,
    string JumpToAnchor );

public void GoTopic();

Open

Opens a project file in the IDE.

public bool Open( string Filename,
    bool Force,
    bool Silent );

public bool Open( string Filename );

SaveTopic

Saves the currently active topic and refreshes the UI.

public void SaveTopic();

SetToolBar

Refreshes the toolbar with common settings for the current mode.

public void SetToolBar();

StatusMessage

Displays a message on the statusbar. This version allows specifying which panel the message displays in and optionally allows progress report information.

public void StatusMessage( string Message,
    string Panel,
    int Percent,
    string Header );

public void StatusMessage( string Message );

AlwaysOntop

If true makes the Help Builder Window topmost and keeps it there.

Config

Help Builder Configuration object that maps to the settings in wwHelp.ini. You can use the property interface to access values or the indexer on this object with the name of the property ( S = (string) Form.Config["LastIndex"] )

Height

Help

Instance of the Help Builder Project (wwHelp) object.

Left

NoOpenFile

Flag that can be used to determine if a file is open in the IDE.

NoOpenTopic

Flag that can be used to determine if a topic is active.

StatusType

Top

ViewerMode

Width

Requirements

Namespace: Westwind.wwHelp
Assembly: wwReflection.DLL

© West Wind Techologies, 2018 • Updated: 07/31/07
Comment or report problem with topic