LockXLS On-line Help Library

Welcome
Getting Started
Using LockXLS
How to ...
Samples
About LockXLS
Purchase
Contact
Use your own help file in application

Use your own help file in application.

You can attach your own Help file to Excel document converted to application. Help file is stored inside the application file. When application is copied to other location Help file is copied too and can be accessed in new location.

By default LockXLS offers to select .chm file, but you can insert any document, even .doc or .txt file.

When application is launched, Help file is extracted and can be accessed from VBA macro:
' declare variable for LockXLS Runtime object
Dim oLockXLS As Object
' create LockXLS Runtime object
Set oLockXLS = CreateObject("LockXLSRuntime.Connect")
' Name of Help file is same as in file, which you've added to LockXLS project.
' For example: you file was MyFile.chm.
oLockXLS.ShowHelpFile("MyFile.chm")
' If you need to show a specific topic (for example topic1.html) you should use the following call:
oLockXLS.ShowHelpFile("MyFile.chm", "topic1")
' release LockXLS Runtime object
Set oLockXLS = Nothing
LockXLS Runtime object has 2 methods to work with your own Help file:
GetHelpFilePath(< HelpFileName >) - returns path to your Help file extracted from application on customer's PC.
ShowHelpFile(< HelpFileName >, < Topic > (optional) ) - shows your Help file by calling HtmlHelp function. Topic is a relative name of the html page included into help file. Second parameter is optional and can be omitted.

You can create your own code which will show a specific topic in Help file. If you use a more simple way and show default topic, LockXLS offers to use ShowHelpFile method.


Contents of the Custom Help file are accessible on Ribbon (Office 2007) or Menu (Office 2000/XP/2003). LockXLS Runtime adds item to ribbon's tab/menu relative to this locked file.

To provide your own caption for Help ribbon item, use Project Settings | Edit string table from this project ....


This Sample Project shows how to attach a Help file to project and call it using VBA macro.