Class wwHelp

The wwHelp class is an instance of a Help Builder Project. It's the non-visual version of Help Builder that allows creation of projects, compilation etc. This object is also available as a subobject of the wwHelpForm object.

// *** Static Factory method
wwHelp Help = wwHelp.CreateInstance();

Help.Open("d:\temp\test\test.hbp")

Help.LoadTopic("INDEX");
Help.Topic.Topic = "New Topic Title for this project"
Help.SaveTopic();

string Html = Help.Topic.RenderTopic();

Help.Close();

Help.Release();
System.Object
  Westwind.wwHelp.wwHelpComWrapper
    Westwind.wwHelp.wwHelp
public class wwHelp : wwHelpComWrapper

Class Members

MemberDescription

Constructor

Overridden constructor to allow passing a COM instance

Close

Closes the currently open project file

public void Close();

CompileProject

Creates the actual CHM file. Note requires that HTML Workshop is installed.

public bool CompileProject();

CreateInstance

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

public static wwHelp CreateInstance();

CreateProject

Creates a new project.

public bool CreateProject( string ProjectFilename,
    string Title,
    string Company );

DeleteTopic

Deletes the currently active topic from the table

public void DeleteTopic( bool DeleteChildren );

FormatHtml

Low level function that renders Help Builder formatted text into HTML. This function knows how to parse content containing double tags and RAWHTML attributes etc. Use this for taking content of fields like Body and rendering it into HTML.

public string FormatHtml( string TopicText );

GenerateHtml

Generates all the HTML output files for the current project

public bool GenerateHtml();

GenerateIndex

Generates the keyword index for the project

public bool GenerateIndex();

GenerateToc

Generates the Content file for this and Content HTML pages for this project.

public bool GenerateToc( int LimitSize,
    bool AllowServerSearch,
    string IconFile );

GetHrefLink

This routine creates a proper HREF link for the current view mode of the control.

public string GetHrefLink( string Title,
    string Pk,
    string ExtraTags,
    string Anchor );

GetProperty

Gets a dynamic property from the XML store.

public object GetProperty( string Property );

GetTopics

Runs a query agains the Help Builder project and returns a DataRow Collection.

public DataRowCollection GetTopics( string FieldList,
    string WhereClause,
    string Order );

InsertInheritanceTree

Returns the Inheritance Tree for the current topic

public string InsertInheritanceTree();

InsertSeeAlsoTopics

Returns an HTML formatted link list for Related topics. Basically takes the value of the SeeAlso field and converts it into HTML.

public string InsertSeeAlsoTopics();

IsTopic

Checks to see if a topic exists in the current help file.

public bool IsTopic( string Pk );

LoadTopic

Loads a topic based on a key. Topic is loaded into the Topic member. You can pass BLANK to get the topic to be blank.

public bool LoadTopic( string Pk,
    TopicTypes TopicType );

public bool LoadTopic( string Pk );

NewTopic

Creates a new topic and loads it into the Topic Member

public bool NewTopic();

Open

Opens an existing project file.

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

public bool Open( string Filename );

OpenForm

Opens a form and sets the HelpForm property to an instance of the form.

public bool OpenForm( string Pk,
    TopicTypes TopicType );

public bool OpenForm( string Pk );

OpenForm

Opens a form and sets the HelpForm property to an instance of the form. c`

public bool OpenForm(string Pk,
TopicTypes TopicType,
string FileName)

Reindex

Packs and Reindexes the Help File.

public bool Reindex();

RenderTopic

Renders the current topic into HTML

public string RenderTopic( string Pk );

public string RenderTopic();

RunWizard

Runs one of the Help Builder's Wizards. Not it opens a form and loads up a new project if no form is open. Generally you should call this method following a call to OpenForm() and whatever Open() commands on the form to load up a specific project.

public void RunWizard( string WizardName );

SaveTableAs

Saves the current project to a new filename.

public bool SaveTableAs( string Filename );

SaveTopic

Saves the currently active topic to disk

public bool SaveTopic();

SetError

Sets the ErrorMesg property with this value. Pass null to clear

public void SetError( string Message );

SetProperty

Retrieves a dynamic value from the XML store. Note that VALUE should be a simple value type only.

public void SetProperty( string Property,
    object Value );

SetTemplate

This method finds the matching template for the current topic type. It returns the name of the template file.

public string SetTemplate( string TopicType );

AppStartPath

Help Builders startup path or the path where the Help Builder application is currently running.

Error

Error flag.

ErrorMsg

Error Message that contains error information on various negative method results.

Filename

The full path to the currently open project file. This file can be empty in which case no project is open

HelpForm

Reference to the Help Form that was created with ShowForm

OutputPath

Path where the generated HTML/CHM/DOC output is generated.

ProjectCompany

The company name associcated with the current project

ProjectIconFile

The Icon file associated with this project

ProjectLanguage

The language of the project in the format: 0x409 English (United States)

ProjectName

Name of the current Help Project

ProjectPath

The path where the project lives

Topic

Object containing all the detail for the currently active topic

Requirements

Namespace: Westwind.wwHelp
Assembly: wwReflection.DLL

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