Shortcut

Creates a shortcut to a specified action by passing Windows-based messages and parameters. For example, if a topic discusses a procedure that involves a specific dialog box, you can provide a link that a user can click in the topic to open the dialog box in the program.

This command can be used only with a compiled help (.chm) file.

Syntax

<PARAM  name="Command" value="ShortCut">
<PARAM  name="Item1"   value=",<i>program name</i>,<i>parameters</i>">
<PARAM  name="Item2"   value="<i>message ID</i>,<i>wPARAM</i>,<i>lPARAM</i>">
[<PARAM name="Button"  value="[Text: <i>Button text</i>|Bitmap: <i>Bitmap file path</i>|Icon:<i>Icon file path</i>]">]
[<PARAM name="Font"    value="<i>Facename[, point size[, charset[, color[, PLAIN BOLD ITALIC UNDERLINE]]]]</i>">]
[<PARAM name="Text"    value="Text: <i>Link text</i>">]

Properties

Button

Specifies the button style. Optional.

Command

Calls the Shortcut command.

Font

Specifies the font attributes. Optional.

Item1

Specifies the file path to the executable file (.exe) for the program, and any parameters to be sent to the program. These values are delimited by a comma.

HTML Help does not support %WINDIR% or other system variables in the file path.

Item2

Specifies the message ID of a standard Windows message, a wPARAM value, and a lPARAM value. These values are delimited by a comma.

Text

Specifies the link text. Optional.

Example

<OBJECT
   id=shortcut
   type="application/x-oleobject"
   classid="clsid:52a2aaae-085d-4187-97ea-8c30db990436"
   codebase="hhctrl.ocx#Version=5,02,3790,1194"
   width=100
   height=100
>
   <PARAM name="Command" value="ShortCut">
   <PARAM name="Button" value="Bitmap:shortcut">
   <PARAM name="Item1" value="notepad,notepad.exe,">
   <PARAM name="Item2" value="273,1,1">
</OBJECT>

Remarks

The Button parameter is omitted when this command is invoked by a script.

Related topics

About Commands